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
36 extern int inc_recurse;
37 extern int blocking_io;
38 extern int human_readable;
39 extern int always_checksum;
40 extern int remove_source_files;
41 extern int output_needs_newline;
42 extern int need_messages_from_generator;
43 extern int kluge_around_eof;
44 extern int got_xfer_error;
45 extern int msgs2stderr;
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;
68 extern int filesfrom_fd;
69 extern int delete_during;
70 extern int connect_timeout;
71 extern int check_for_io_err;
72 extern pid_t cleanup_child_pid;
73 extern unsigned int module_dirlen;
74 extern struct stats stats;
75 extern char *stdout_format;
76 extern char *logfile_format;
77 extern char *filesfrom_host;
78 extern char *partial_dir;
79 extern char *dest_option;
80 extern char *rsync_path;
81 extern char *shell_cmd;
82 extern char *batch_name;
83 extern char *password_file;
84 extern char curr_dir[MAXPATHLEN];
85 extern char *basis_dir[MAX_BASIS_DIRS+1];
86 extern struct file_list *first_flist;
87 extern struct filter_list_struct daemon_filter_list;
92 int daemon_over_rsh = 0;
93 mode_t orig_umask = 0;
94 int batch_gen_fd = -1;
95 int sender_keeps_checksum = 0;
97 /* There's probably never more than at most 2 outstanding child processes,
98 * but set it higher, just in case. */
99 #define MAXCHILDPROCS 7
101 #ifdef HAVE_SIGACTION
102 # ifdef HAVE_SIGPROCMASK
103 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
105 # define SIGACTMASK(n,h) SIGACTION(n,h)
107 static struct sigaction sigact;
113 } pid_stat_table[MAXCHILDPROCS];
115 static time_t starttime, endtime;
116 static int64 total_read, total_written;
118 static void show_malloc_stats(void);
120 /* Works like waitpid(), but if we already harvested the child pid in our
121 * remember_children(), we succeed instead of returning an error. */
122 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
127 waited_pid = waitpid(pid, status_ptr, flags);
128 } while (waited_pid == -1 && errno == EINTR);
130 if (waited_pid == -1 && errno == ECHILD) {
131 /* Status of requested child no longer available: check to
132 * see if it was processed by remember_children(). */
134 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
135 if (pid == pid_stat_table[cnt].pid) {
136 *status_ptr = pid_stat_table[cnt].status;
137 pid_stat_table[cnt].pid = 0;
146 /* Wait for a process to exit, calling io_flush while waiting. */
147 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
152 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
154 io_flush(FULL_FLUSH);
157 /* TODO: If the child exited on a signal, then log an
158 * appropriate error message. Perhaps we should also accept a
159 * message describing the purpose of the child. Also indicate
160 * this to the caller so that they know something went wrong. */
161 if (waited_pid < 0) {
162 rsyserr(FERROR, errno, "waitpid");
163 *exit_code_ptr = RERR_WAITCHILD;
164 } else if (!WIFEXITED(status)) {
166 if (WCOREDUMP(status))
167 *exit_code_ptr = RERR_CRASHED;
170 if (WIFSIGNALED(status))
171 *exit_code_ptr = RERR_TERMINATED;
173 *exit_code_ptr = RERR_WAITCHILD;
175 *exit_code_ptr = WEXITSTATUS(status);
178 /* This function gets called from all 3 processes. We want the client side
179 * to actually output the text, but the sender is the only process that has
180 * all the stats we need. So, if we're a client sender, we do the report.
181 * If we're a server sender, we write the stats on the supplied fd. If
182 * we're the client receiver we read the stats from the supplied fd and do
183 * the report. All processes might also generate a set of debug stats, if
184 * the verbose level is high enough (this is the only thing that the
185 * generator process and the server receiver ever do here). */
186 static void handle_stats(int f)
188 endtime = time(NULL);
190 /* Cache two stats because the read/write code can change it. */
191 total_read = stats.total_read;
192 total_written = stats.total_written;
194 if (INFO_GTE(STATS, 3)) {
195 /* These come out from every process */
204 if (f == -1 || !am_sender)
210 write_varlong30(f, total_read, 3);
211 write_varlong30(f, total_written, 3);
212 write_varlong30(f, stats.total_size, 3);
213 if (protocol_version >= 29) {
214 write_varlong30(f, stats.flist_buildtime, 3);
215 write_varlong30(f, stats.flist_xfertime, 3);
221 /* this is the client */
223 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
225 else if (!am_sender) {
226 /* Read the first two in opposite order because the meaning of
227 * read/write swaps when switching from sender to receiver. */
228 total_written = read_varlong30(f, 3);
229 total_read = read_varlong30(f, 3);
230 stats.total_size = read_varlong30(f, 3);
231 if (protocol_version >= 29) {
232 stats.flist_buildtime = read_varlong30(f, 3);
233 stats.flist_xfertime = read_varlong30(f, 3);
235 } else if (write_batch) {
236 /* The --read-batch process is going to be a client
237 * receiver, so we need to give it the stats. */
238 write_varlong30(batch_fd, total_read, 3);
239 write_varlong30(batch_fd, total_written, 3);
240 write_varlong30(batch_fd, stats.total_size, 3);
241 if (protocol_version >= 29) {
242 write_varlong30(batch_fd, stats.flist_buildtime, 3);
243 write_varlong30(batch_fd, stats.flist_xfertime, 3);
248 static void output_summary(void)
250 if (INFO_GTE(STATS, 2)) {
251 rprintf(FCLIENT, "\n");
252 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
253 rprintf(FINFO,"Number of files transferred: %d\n",
254 stats.num_transferred_files);
255 rprintf(FINFO,"Total file size: %s bytes\n",
256 big_num(stats.total_size, human_readable));
257 rprintf(FINFO,"Total transferred file size: %s bytes\n",
258 big_num(stats.total_transferred_size, human_readable));
259 rprintf(FINFO,"Literal data: %s bytes\n",
260 big_num(stats.literal_data, human_readable));
261 rprintf(FINFO,"Matched data: %s bytes\n",
262 big_num(stats.matched_data, human_readable));
263 rprintf(FINFO,"File list size: %s\n",
264 big_num(stats.flist_size, human_readable));
265 if (stats.flist_buildtime) {
267 "File list generation time: %.3f seconds\n",
268 (double)stats.flist_buildtime / 1000);
270 "File list transfer time: %.3f seconds\n",
271 (double)stats.flist_xfertime / 1000);
273 rprintf(FINFO,"Total bytes sent: %s\n",
274 big_num(total_written, human_readable));
275 rprintf(FINFO,"Total bytes received: %s\n",
276 big_num(total_read, human_readable));
279 if (INFO_GTE(STATS, 1)) {
280 rprintf(FCLIENT, "\n");
282 "sent %s bytes received %s bytes %s bytes/sec\n",
283 big_num(total_written, human_readable),
284 big_num(total_read, human_readable),
285 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
286 rprintf(FINFO, "total size is %s speedup is %.2f%s\n",
287 big_num(stats.total_size, human_readable),
288 (double)stats.total_size / (total_written+total_read),
289 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
298 * If our C library can get malloc statistics, then show them to FINFO
300 static void show_malloc_stats(void)
307 rprintf(FCLIENT, "\n");
308 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
309 getpid(), am_server ? "server " : "",
310 am_daemon ? "daemon " : "", who_am_i());
311 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
313 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
315 rprintf(FINFO, " smblks: %10ld\n",
317 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
319 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
321 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
322 (long)mi.arena + mi.hblkhd);
323 rprintf(FINFO, " usmblks: %10ld\n",
325 rprintf(FINFO, " fsmblks: %10ld\n",
327 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
329 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
331 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
333 #endif /* HAVE_MALLINFO */
337 /* Start the remote shell. cmd may be NULL to use the default. */
338 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
339 int *f_in_p, int *f_out_p)
342 char *args[MAX_ARGS];
346 if (!read_batch && !local_server) {
347 char *t, *f, in_quote = '\0';
348 char *rsh_env = getenv(RSYNC_RSH_ENV);
353 cmd = strdup(cmd); /* MEMORY LEAK */
357 for (t = f = cmd; *f; f++) {
360 /* Comparison leaves rooms for server_options(). */
361 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
364 while (*f != ' ' || in_quote) {
368 "Missing trailing-%c in remote-shell command.\n",
370 exit_cleanup(RERR_SYNTAX);
375 if (*f == '\'' || *f == '"') {
380 if (*f == in_quote && *++f != in_quote) {
390 /* check to see if we've already been given '-l user' in
391 * the remote-shell command */
392 for (i = 0; i < argc-1; i++) {
393 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
398 /* remsh (on HPUX) takes the arguments the other way around */
399 args[argc++] = machine;
400 if (user && !(daemon_over_rsh && dash_l_set)) {
405 if (user && !(daemon_over_rsh && dash_l_set)) {
409 args[argc++] = machine;
412 args[argc++] = rsync_path;
414 if (blocking_io < 0) {
416 if ((cp = strrchr(cmd, '/')) != NULL)
420 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
424 server_options(args,&argc);
426 if (argc >= MAX_ARGS - 2)
432 if (!daemon_over_rsh) {
433 while (remote_argc > 0) {
434 if (argc >= MAX_ARGS - 1) {
436 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
437 exit_cleanup(RERR_SYNTAX);
439 args[argc++] = *remote_argv++;
446 if (DEBUG_GTE(CMD, 2)) {
447 for (i = 0; i < argc; i++)
448 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
449 rprintf(FCLIENT, "\n");
453 int from_gen_pipe[2];
454 set_allow_inc_recurse();
455 if (fd_pair(from_gen_pipe) < 0) {
456 rsyserr(FERROR, errno, "pipe");
457 exit_cleanup(RERR_IPC);
459 batch_gen_fd = from_gen_pipe[0];
460 *f_out_p = from_gen_pipe[1];
462 pid = (pid_t)-1; /* no child pid */
466 } else if (local_server) {
467 /* If the user didn't request --[no-]whole-file, force
468 * it on, but only if we're not batch processing. */
469 if (whole_file < 0 && !write_batch)
471 set_allow_inc_recurse();
472 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
477 pid = piped_child(args, f_in_p, f_out_p);
482 send_protected_args(*f_out_p, args);
488 out_of_memory("do_cmd");
489 return 0; /* not reached */
492 /* The receiving side operates in one of two modes:
494 * 1. it receives any number of files into a destination directory,
495 * placing them according to their names in the file-list.
497 * 2. it receives a single file and saves it using the name in the
498 * destination path instead of its file-list name. This requires a
499 * "local name" for writing out the destination file.
501 * So, our task is to figure out what mode/local-name we need.
502 * For mode 1, we change into the destination directory and return NULL.
503 * For mode 2, we change into the directory containing the destination
504 * file (if we aren't already there) and return the local-name. */
505 static char *get_local_name(struct file_list *flist, char *dest_path)
511 if (DEBUG_GTE(RECV, 1)) {
512 rprintf(FINFO, "get_local_name count=%d %s\n",
513 file_total, NS(dest_path));
516 if (!dest_path || list_only)
519 if (daemon_filter_list.head) {
520 char *slash = strrchr(dest_path, '/');
521 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
525 if ((*dest_path != '.' || dest_path[1] != '\0')
526 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
527 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
528 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
530 exit_cleanup(RERR_FILESELECT);
536 /* See what currently exists at the destination. */
537 if ((statret = do_stat(dest_path, &st)) == 0) {
538 /* If the destination is a dir, enter it and use mode 1. */
539 if (S_ISDIR(st.st_mode)) {
540 if (!change_dir(dest_path, CD_NORMAL)) {
541 rsyserr(FERROR, errno, "change_dir#1 %s failed",
542 full_fname(dest_path));
543 exit_cleanup(RERR_FILESELECT);
547 if (file_total > 1) {
549 "ERROR: destination must be a directory when"
550 " copying more than 1 file\n");
551 exit_cleanup(RERR_FILESELECT);
553 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
555 "ERROR: cannot overwrite non-directory"
556 " with a directory\n");
557 exit_cleanup(RERR_FILESELECT);
559 } else if (errno != ENOENT) {
560 /* If we don't know what's at the destination, fail. */
561 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
562 full_fname(dest_path));
563 exit_cleanup(RERR_FILESELECT);
566 cp = strrchr(dest_path, '/');
568 /* If we need a destination directory because the transfer is not
569 * of a single non-directory or the user has requested one via a
570 * destination path ending in a slash, create one and use mode 1. */
571 if (file_total > 1 || (cp && !cp[1])) {
572 /* Lop off the final slash (if any). */
578 "ERROR: destination path is not a directory\n");
579 exit_cleanup(RERR_SYNTAX);
582 if (mkdir_defmode(dest_path) != 0) {
583 rsyserr(FERROR, errno, "mkdir %s failed",
584 full_fname(dest_path));
585 exit_cleanup(RERR_FILEIO);
588 if (flist->high >= flist->low
589 && strcmp(flist->files[flist->low]->basename, ".") == 0)
590 flist->files[0]->flags |= FLAG_DIR_CREATED;
592 if (INFO_GTE(NAME, 1))
593 rprintf(FINFO, "created directory %s\n", dest_path);
596 /* Indicate that dest dir doesn't really exist. */
600 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
601 rsyserr(FERROR, errno, "change_dir#2 %s failed",
602 full_fname(dest_path));
603 exit_cleanup(RERR_FILESELECT);
609 /* Otherwise, we are writing a single file, possibly on top of an
610 * existing non-directory. Change to the item's parent directory
611 * (if it has a path component), return the basename of the
612 * destination file as the local name, and use mode 2. */
620 if (!change_dir(dest_path, CD_NORMAL)) {
621 rsyserr(FERROR, errno, "change_dir#3 %s failed",
622 full_fname(dest_path));
623 exit_cleanup(RERR_FILESELECT);
630 /* This function checks on our alternate-basis directories. If we're in
631 * dry-run mode and the destination dir does not yet exist, we'll try to
632 * tweak any dest-relative paths to make them work for a dry-run (the
633 * destination dir must be in curr_dir[] when this function is called).
634 * We also warn about any arg that is non-existent or not a directory. */
635 static void check_alt_basis_dirs(void)
638 char **dir_p, *slash = strrchr(curr_dir, '/');
640 for (dir_p = basis_dir; *dir_p; dir_p++) {
641 if (dry_run > 1 && **dir_p != '/') {
642 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
643 char *new = new_array(char, len);
645 out_of_memory("check_alt_basis_dirs");
646 if (slash && strncmp(*dir_p, "../", 3) == 0) {
647 /* We want to remove only one leading "../" prefix for
648 * the directory we couldn't create in dry-run mode:
649 * this ensures that any other ".." references get
650 * evaluated the same as they would for a live copy. */
652 pathjoin(new, len, curr_dir, *dir_p + 3);
655 pathjoin(new, len, curr_dir, *dir_p);
658 if (do_stat(*dir_p, &st) < 0) {
659 rprintf(FWARNING, "%s arg does not exist: %s\n",
660 dest_option, *dir_p);
661 } else if (!S_ISDIR(st.st_mode)) {
662 rprintf(FWARNING, "%s arg is not a dir: %s\n",
663 dest_option, *dir_p);
668 /* This is only called by the sender. */
669 static void read_final_goodbye(int f_in)
673 char xname[MAXPATHLEN];
675 if (protocol_version < 29)
678 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
683 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
685 exit_cleanup(RERR_PROTOCOL);
689 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
691 struct file_list *flist;
694 if (DEBUG_GTE(SEND, 1)) {
695 rprintf(FINFO, "server_sender starting pid=%ld\n",
699 if (am_daemon && lp_write_only(module_id)) {
700 rprintf(FERROR, "ERROR: module is write only\n");
701 exit_cleanup(RERR_SYNTAX);
704 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
706 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
707 remove_source_files == 1 ? "source" : "sent");
708 exit_cleanup(RERR_SYNTAX);
712 if (!relative_paths) {
713 if (!change_dir(dir, CD_NORMAL)) {
714 rsyserr(FERROR, errno, "change_dir#3 %s failed",
716 exit_cleanup(RERR_FILESELECT);
722 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
728 flist = send_file_list(f_out,argc,argv);
729 if (!flist || flist->used == 0)
732 io_start_buffering_in(f_in);
734 send_files(f_in, f_out);
735 io_flush(FULL_FLUSH);
737 if (protocol_version >= 24)
738 read_final_goodbye(f_in);
739 io_flush(FULL_FLUSH);
744 static int do_recv(int f_in, int f_out, char *local_name)
750 /* The receiving side mustn't obey this, or an existing symlink that
751 * points to an identical file won't be replaced by the referent. */
752 copy_links = copy_dirlinks = copy_unsafe_links = 0;
754 #ifdef SUPPORT_HARD_LINKS
755 if (preserve_hard_links && !inc_recurse)
756 match_hard_links(first_flist);
759 if (fd_pair(error_pipe) < 0) {
760 rsyserr(FERROR, errno, "pipe failed in do_recv");
761 exit_cleanup(RERR_IPC);
764 io_flush(NORMAL_FLUSH);
766 if ((pid = do_fork()) == -1) {
767 rsyserr(FERROR, errno, "fork failed in do_recv");
768 exit_cleanup(RERR_IPC);
771 check_for_io_err = inc_recurse && delete_during && !flist_eof;
774 close(error_pipe[0]);
778 /* we can't let two processes write to the socket at one time */
779 io_end_multiplex_out();
781 /* set place to send errors */
782 set_msg_fd_out(error_pipe[1]);
783 io_start_buffering_out(error_pipe[1]);
785 recv_files(f_in, local_name);
786 io_flush(FULL_FLUSH);
789 if (output_needs_newline) {
791 output_needs_newline = 0;
794 send_msg(MSG_DONE, "", 1, 0);
795 write_varlong(error_pipe[1], stats.total_read, 3);
796 io_flush(FULL_FLUSH);
798 /* Handle any keep-alive packets from the post-processing work
799 * that the generator does. */
800 if (protocol_version >= 29) {
803 char xname[MAXPATHLEN];
805 kluge_around_eof = -1;
807 /* This should only get stopped via a USR2 signal. */
808 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
811 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
813 exit_cleanup(RERR_PROTOCOL);
816 /* Finally, we go to sleep until our parent kills us with a
817 * USR2 signal. We sleep for a short time, as on some OSes
818 * a signal won't interrupt a sleep! */
825 io_end_multiplex_in();
826 if (write_batch && !am_server)
829 close(error_pipe[1]);
833 io_start_buffering_out(f_out);
835 set_msg_fd_in(error_pipe[0]);
836 io_start_buffering_in(error_pipe[0]);
838 #ifdef SUPPORT_HARD_LINKS
839 if (preserve_hard_links && inc_recurse) {
840 struct file_list *flist;
841 for (flist = first_flist; flist; flist = flist->next)
842 match_hard_links(flist);
846 generate_files(f_out, local_name);
849 io_flush(FULL_FLUSH);
850 if (protocol_version >= 24) {
851 /* send a final goodbye message */
852 write_ndx(f_out, NDX_DONE);
854 io_flush(FULL_FLUSH);
858 wait_process_with_flush(pid, &exit_code);
862 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
865 struct file_list *flist;
866 char *local_name = NULL;
869 if (filesfrom_fd >= 0 && !msgs2stderr) {
870 /* We can't mix messages with files-from data on the socket,
871 * so temporarily turn off info/debug messages. */
872 negate_output_levels();
877 if (DEBUG_GTE(RECV, 1)) {
878 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
879 argc, (long)getpid());
882 if (am_daemon && lp_read_only(module_id)) {
883 rprintf(FERROR,"ERROR: module is read only\n");
884 exit_cleanup(RERR_SYNTAX);
892 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
893 rsyserr(FERROR, errno, "change_dir#4 %s failed",
895 exit_cleanup(RERR_FILESELECT);
899 if (protocol_version >= 30)
900 io_start_multiplex_in();
902 io_start_buffering_in(f_in);
903 recv_filter_list(f_in);
905 if (filesfrom_fd >= 0) {
906 /* We need to send the files-from names to the sender at the
907 * same time that we receive the file-list from them, so we
908 * need the IO routines to automatically write out the names
909 * onto our f_out socket as we read the file-list. This
910 * avoids both deadlock and extra delays/buffers. */
911 io_set_filesfrom_fds(filesfrom_fd, f_out);
915 flist = recv_file_list(f_in);
917 rprintf(FERROR,"server_recv: recv_file_list error\n");
918 exit_cleanup(RERR_FILESELECT);
920 if (inc_recurse && file_total == 1)
921 recv_additional_file_list(f_in);
924 negate_output_levels();
927 local_name = get_local_name(flist,argv[0]);
929 /* Now that we know what our destination directory turned out to be,
930 * we can sanitize the --link-/copy-/compare-dest args correctly. */
931 if (sanitize_paths) {
933 for (dir_p = basis_dir; *dir_p; dir_p++)
934 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
936 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
938 check_alt_basis_dirs();
940 if (daemon_filter_list.head) {
942 struct filter_list_struct *elp = &daemon_filter_list;
944 for (dir_p = basis_dir; *dir_p; dir_p++) {
947 dir += module_dirlen;
948 if (check_filter(elp, FLOG, dir, 1) < 0)
949 goto options_rejected;
951 if (partial_dir && *partial_dir == '/'
952 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
955 "Your options have been rejected by the server.\n");
956 exit_cleanup(RERR_SYNTAX);
960 exit_code = do_recv(f_in, f_out, local_name);
961 exit_cleanup(exit_code);
965 int child_main(int argc, char *argv[])
967 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
972 void start_server(int f_in, int f_out, int argc, char *argv[])
974 set_nonblocking(f_in);
975 set_nonblocking(f_out);
977 io_set_sock_fds(f_in, f_out);
978 setup_protocol(f_out, f_in);
980 if (protocol_version >= 23)
981 io_start_multiplex_out();
984 keep_dirlinks = 0; /* Must be disabled on the sender. */
985 if (need_messages_from_generator)
986 io_start_multiplex_in();
987 recv_filter_list(f_in);
988 do_server_sender(f_in, f_out, argc, argv);
990 do_server_recv(f_in, f_out, argc, argv);
996 * This is called once the connection has been negotiated. It is used
997 * for rsyncd, remote-shell, and local connections.
999 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1001 struct file_list *flist = NULL;
1002 int exit_code = 0, exit_code2 = 0;
1003 char *local_name = NULL;
1005 cleanup_child_pid = pid;
1007 set_nonblocking(f_in);
1008 set_nonblocking(f_out);
1011 io_set_sock_fds(f_in, f_out);
1012 setup_protocol(f_out,f_in);
1014 /* We set our stderr file handle to blocking because ssh might have
1015 * set it to non-blocking. This can be particularly troublesome if
1016 * stderr is a clone of stdout, because ssh would have set our stdout
1017 * to non-blocking at the same time (which can easily cause us to lose
1018 * output from our print statements). This kluge shouldn't cause ssh
1019 * any problems for how we use it. Note also that we delayed setting
1020 * this until after the above protocol setup so that we know for sure
1021 * that ssh is done twiddling its file descriptors. */
1022 set_blocking(STDERR_FILENO);
1025 keep_dirlinks = 0; /* Must be disabled on the sender. */
1028 && (log_format_has(stdout_format, 'C')
1029 || log_format_has(logfile_format, 'C')))
1030 sender_keeps_checksum = 1;
1032 if (protocol_version >= 30)
1033 io_start_multiplex_out();
1035 io_start_buffering_out(f_out);
1036 if (!filesfrom_host)
1037 set_msg_fd_in(f_in);
1038 send_filter_list(f_out);
1040 filesfrom_fd = f_in;
1042 if (write_batch && !am_server)
1043 start_write_batch(f_out);
1044 flist = send_file_list(f_out, argc, argv);
1046 if (DEBUG_GTE(FLIST, 3))
1047 rprintf(FINFO,"file list sent\n");
1049 if (protocol_version >= 23)
1050 io_start_multiplex_in();
1052 io_flush(NORMAL_FLUSH);
1053 send_files(f_in, f_out);
1054 io_flush(FULL_FLUSH);
1056 if (protocol_version >= 24)
1057 read_final_goodbye(f_in);
1059 if (DEBUG_GTE(EXIT, 2))
1060 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1061 io_flush(FULL_FLUSH);
1062 wait_process_with_flush(pid, &exit_code);
1065 io_flush(FULL_FLUSH);
1066 exit_cleanup(exit_code);
1070 if (protocol_version >= 23)
1071 io_start_multiplex_in();
1072 if (need_messages_from_generator)
1073 io_start_multiplex_out();
1076 send_filter_list(read_batch ? -1 : f_out);
1078 if (filesfrom_fd >= 0) {
1079 io_set_filesfrom_fds(filesfrom_fd, f_out);
1083 if (write_batch && !am_server)
1084 start_write_batch(f_in);
1085 flist = recv_file_list(f_in);
1086 if (inc_recurse && file_total == 1)
1087 recv_additional_file_list(f_in);
1089 if (flist && flist->used > 0) {
1090 local_name = get_local_name(flist, argv[0]);
1092 check_alt_basis_dirs();
1094 exit_code2 = do_recv(f_in, f_out, local_name);
1101 if (DEBUG_GTE(RECV, 1))
1102 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1103 io_flush(FULL_FLUSH);
1104 wait_process_with_flush(pid, &exit_code);
1107 return MAX(exit_code, exit_code2);
1110 static int copy_argv(char *argv[])
1114 for (i = 0; argv[i]; i++) {
1115 if (!(argv[i] = strdup(argv[i]))) {
1116 rprintf (FERROR, "out of memory at %s(%d)\n",
1117 __FILE__, __LINE__);
1127 * Start a client for either type of remote connection. Work out
1128 * whether the arguments request a remote shell or rsyncd connection,
1129 * and call the appropriate connection function, then run_client.
1131 * Calls either start_socket_client (for sockets) or do_cmd and
1132 * client_run (for ssh).
1134 static int start_client(int argc, char *argv[])
1136 char *p, *shell_machine = NULL, *shell_user = NULL;
1143 /* Don't clobber argv[] so that ps(1) can still show the right
1145 if ((ret = copy_argv(argv)) != 0)
1148 if (!read_batch) { /* for read_batch, NO source is specified */
1149 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1150 if (path) { /* source is remote */
1157 if (argc == 1 || **argv == ':')
1158 argc = 0; /* no dest arg */
1159 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1161 "The source and destination cannot both be remote.\n");
1162 exit_cleanup(RERR_SYNTAX);
1164 remote_argc--; /* don't count dest */
1167 if (filesfrom_host && *filesfrom_host
1168 && strcmp(filesfrom_host, shell_machine) != 0) {
1170 "--files-from hostname is not the same as the transfer hostname\n");
1171 exit_cleanup(RERR_SYNTAX);
1175 daemon_over_rsh = shell_cmd ? 1 : -1;
1176 } else { /* source is local, check dest arg */
1181 remote_argv = argv + argc;
1183 static char *dotarg[1] = { "." };
1185 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;
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;
1283 if (DEBUG_GTE(CMD, 2)) {
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);
1428 am_root = our_uid == 0;
1430 memset(&stats, 0, sizeof(stats));
1434 exit_cleanup(RERR_SYNTAX);
1437 /* we set a 0 umask so that correct file permissions can be
1439 orig_umask = umask(0);
1441 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1442 setlocale(LC_CTYPE, "");
1445 if (!parse_arguments(&argc, (const char ***) &argv)) {
1446 /* FIXME: We ought to call the same error-handling
1447 * code here, rather than relying on getopt. */
1449 exit_cleanup(RERR_SYNTAX);
1452 SIGACTMASK(SIGINT, sig_int);
1453 SIGACTMASK(SIGHUP, sig_int);
1454 SIGACTMASK(SIGTERM, sig_int);
1455 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1456 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1459 /* Ignore SIGPIPE; we consistently check error codes and will
1461 SIGACTION(SIGPIPE, SIG_IGN);
1463 SIGACTION(SIGXFSZ, SIG_IGN);
1466 /* Initialize change_dir() here because on some old systems getcwd
1467 * (implemented by forking "pwd" and reading its output) doesn't
1468 * work when there are other child processes. Also, on all systems
1469 * that implement getcwd that way "pwd" can't be found after chroot. */
1470 change_dir(NULL, CD_NORMAL);
1474 if ((write_batch || read_batch) && !am_server) {
1476 write_batch_shell_file(orig_argc, orig_argv, argc);
1478 if (read_batch && strcmp(batch_name, "-") == 0)
1479 batch_fd = STDIN_FILENO;
1481 batch_fd = do_open(batch_name,
1482 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1483 : O_RDONLY, S_IRUSR | S_IWUSR);
1486 rsyserr(FERROR, errno, "Batch file %s open error",
1487 full_fname(batch_name));
1488 exit_cleanup(RERR_FILEIO);
1491 read_stream_flags(batch_fd);
1493 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)) {
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);