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 always_checksum;
39 extern int remove_source_files;
40 extern int output_needs_newline;
41 extern int need_messages_from_generator;
42 extern int kluge_around_eof;
43 extern int got_xfer_error;
44 extern int msgs2stderr;
46 extern int copy_links;
47 extern int copy_dirlinks;
48 extern int copy_unsafe_links;
49 extern int keep_dirlinks;
50 extern int preserve_hard_links;
51 extern int protocol_version;
52 extern int file_total;
55 extern int protect_args;
56 extern int relative_paths;
57 extern int sanitize_paths;
58 extern int curr_dir_depth;
59 extern int curr_dir_len;
61 extern int rsync_port;
62 extern int whole_file;
63 extern int read_batch;
64 extern int write_batch;
66 extern int filesfrom_fd;
67 extern int connect_timeout;
68 extern pid_t cleanup_child_pid;
69 extern unsigned int module_dirlen;
70 extern struct stats stats;
71 extern char *stdout_format;
72 extern char *logfile_format;
73 extern char *filesfrom_host;
74 extern char *partial_dir;
75 extern char *dest_option;
76 extern char *rsync_path;
77 extern char *shell_cmd;
78 extern char *batch_name;
79 extern char *password_file;
80 extern char curr_dir[MAXPATHLEN];
81 extern char *basis_dir[MAX_BASIS_DIRS+1];
82 extern struct file_list *first_flist;
83 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: %s\n", comma_num(stats.num_files));
249 rprintf(FINFO,"Number of files transferred: %s\n",
250 comma_num(stats.num_transferred_files));
251 rprintf(FINFO,"Total file size: %s bytes\n",
252 human_num(stats.total_size));
253 rprintf(FINFO,"Total transferred file size: %s bytes\n",
254 human_num(stats.total_transferred_size));
255 rprintf(FINFO,"Literal data: %s bytes\n",
256 human_num(stats.literal_data));
257 rprintf(FINFO,"Matched data: %s bytes\n",
258 human_num(stats.matched_data));
259 rprintf(FINFO,"File list size: %s\n",
260 human_num(stats.flist_size));
261 if (stats.flist_buildtime) {
263 "File list generation time: %s seconds\n",
264 comma_dnum((double)stats.flist_buildtime / 1000, 3));
266 "File list transfer time: %s seconds\n",
267 comma_dnum((double)stats.flist_xfertime / 1000, 3));
269 rprintf(FINFO,"Total bytes sent: %s\n",
270 human_num(total_written));
271 rprintf(FINFO,"Total bytes received: %s\n",
272 human_num(total_read));
275 if (INFO_GTE(STATS, 1)) {
276 rprintf(FCLIENT, "\n");
278 "sent %s bytes received %s bytes %s bytes/sec\n",
279 human_num(total_written), human_num(total_read),
280 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
281 rprintf(FINFO, "total size is %s speedup is %s%s\n",
282 human_num(stats.total_size),
283 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
284 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
293 * If our C library can get malloc statistics, then show them to FINFO
295 static void show_malloc_stats(void)
302 rprintf(FCLIENT, "\n");
303 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
304 getpid(), am_server ? "server " : "",
305 am_daemon ? "daemon " : "", who_am_i());
306 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
308 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
310 rprintf(FINFO, " smblks: %10ld\n",
312 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
314 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
316 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
317 (long)mi.arena + mi.hblkhd);
318 rprintf(FINFO, " usmblks: %10ld\n",
320 rprintf(FINFO, " fsmblks: %10ld\n",
322 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
324 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
326 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
328 #endif /* HAVE_MALLINFO */
332 /* Start the remote shell. cmd may be NULL to use the default. */
333 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
334 int *f_in_p, int *f_out_p)
337 char *args[MAX_ARGS];
341 if (!read_batch && !local_server) {
342 char *t, *f, in_quote = '\0';
343 char *rsh_env = getenv(RSYNC_RSH_ENV);
348 cmd = strdup(cmd); /* MEMORY LEAK */
352 for (t = f = cmd; *f; f++) {
355 /* Comparison leaves rooms for server_options(). */
356 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
359 while (*f != ' ' || in_quote) {
363 "Missing trailing-%c in remote-shell command.\n",
365 exit_cleanup(RERR_SYNTAX);
370 if (*f == '\'' || *f == '"') {
375 if (*f == in_quote && *++f != in_quote) {
385 /* check to see if we've already been given '-l user' in
386 * the remote-shell command */
387 for (i = 0; i < argc-1; i++) {
388 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
393 /* remsh (on HPUX) takes the arguments the other way around */
394 args[argc++] = machine;
395 if (user && !(daemon_over_rsh && dash_l_set)) {
400 if (user && !(daemon_over_rsh && dash_l_set)) {
404 args[argc++] = machine;
407 args[argc++] = rsync_path;
409 if (blocking_io < 0) {
411 if ((cp = strrchr(cmd, '/')) != NULL)
415 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
419 server_options(args,&argc);
421 if (argc >= MAX_ARGS - 2)
427 if (!daemon_over_rsh) {
428 while (remote_argc > 0) {
429 if (argc >= MAX_ARGS - 1) {
431 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
432 exit_cleanup(RERR_SYNTAX);
434 args[argc++] = *remote_argv++;
441 if (DEBUG_GTE(CMD, 2)) {
442 for (i = 0; i < argc; i++)
443 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
444 rprintf(FCLIENT, "\n");
448 int from_gen_pipe[2];
449 set_allow_inc_recurse();
450 if (fd_pair(from_gen_pipe) < 0) {
451 rsyserr(FERROR, errno, "pipe");
452 exit_cleanup(RERR_IPC);
454 batch_gen_fd = from_gen_pipe[0];
455 *f_out_p = from_gen_pipe[1];
457 pid = (pid_t)-1; /* no child pid */
461 } else if (local_server) {
462 /* If the user didn't request --[no-]whole-file, force
463 * it on, but only if we're not batch processing. */
464 if (whole_file < 0 && !write_batch)
466 set_allow_inc_recurse();
467 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
472 pid = piped_child(args, f_in_p, f_out_p);
477 send_protected_args(*f_out_p, args);
483 out_of_memory("do_cmd");
484 return 0; /* not reached */
487 /* The receiving side operates in one of two modes:
489 * 1. it receives any number of files into a destination directory,
490 * placing them according to their names in the file-list.
492 * 2. it receives a single file and saves it using the name in the
493 * destination path instead of its file-list name. This requires a
494 * "local name" for writing out the destination file.
496 * So, our task is to figure out what mode/local-name we need.
497 * For mode 1, we change into the destination directory and return NULL.
498 * For mode 2, we change into the directory containing the destination
499 * file (if we aren't already there) and return the local-name. */
500 static char *get_local_name(struct file_list *flist, char *dest_path)
506 if (DEBUG_GTE(RECV, 1)) {
507 rprintf(FINFO, "get_local_name count=%d %s\n",
508 file_total, NS(dest_path));
511 if (!dest_path || list_only)
514 if (daemon_filter_list.head) {
515 char *slash = strrchr(dest_path, '/');
516 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
520 if ((*dest_path != '.' || dest_path[1] != '\0')
521 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
522 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
523 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
525 exit_cleanup(RERR_FILESELECT);
531 /* See what currently exists at the destination. */
532 if ((statret = do_stat(dest_path, &st)) == 0) {
533 /* If the destination is a dir, enter it and use mode 1. */
534 if (S_ISDIR(st.st_mode)) {
535 if (!change_dir(dest_path, CD_NORMAL)) {
536 rsyserr(FERROR, errno, "change_dir#1 %s failed",
537 full_fname(dest_path));
538 exit_cleanup(RERR_FILESELECT);
542 if (file_total > 1) {
544 "ERROR: destination must be a directory when"
545 " copying more than 1 file\n");
546 exit_cleanup(RERR_FILESELECT);
548 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
550 "ERROR: cannot overwrite non-directory"
551 " with a directory\n");
552 exit_cleanup(RERR_FILESELECT);
554 } else if (errno != ENOENT) {
555 /* If we don't know what's at the destination, fail. */
556 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
557 full_fname(dest_path));
558 exit_cleanup(RERR_FILESELECT);
561 cp = strrchr(dest_path, '/');
563 /* If we need a destination directory because the transfer is not
564 * of a single non-directory or the user has requested one via a
565 * destination path ending in a slash, create one and use mode 1. */
566 if (file_total > 1 || (cp && !cp[1])) {
567 /* Lop off the final slash (if any). */
573 "ERROR: destination path is not a directory\n");
574 exit_cleanup(RERR_SYNTAX);
577 if (mkdir_defmode(dest_path) != 0) {
578 rsyserr(FERROR, errno, "mkdir %s failed",
579 full_fname(dest_path));
580 exit_cleanup(RERR_FILEIO);
583 if (flist->high >= flist->low
584 && strcmp(flist->files[flist->low]->basename, ".") == 0)
585 flist->files[0]->flags |= FLAG_DIR_CREATED;
587 if (INFO_GTE(NAME, 1))
588 rprintf(FINFO, "created directory %s\n", dest_path);
591 /* Indicate that dest dir doesn't really exist. */
595 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
596 rsyserr(FERROR, errno, "change_dir#2 %s failed",
597 full_fname(dest_path));
598 exit_cleanup(RERR_FILESELECT);
604 /* Otherwise, we are writing a single file, possibly on top of an
605 * existing non-directory. Change to the item's parent directory
606 * (if it has a path component), return the basename of the
607 * destination file as the local name, and use mode 2. */
615 if (!change_dir(dest_path, CD_NORMAL)) {
616 rsyserr(FERROR, errno, "change_dir#3 %s failed",
617 full_fname(dest_path));
618 exit_cleanup(RERR_FILESELECT);
625 /* This function checks on our alternate-basis directories. If we're in
626 * dry-run mode and the destination dir does not yet exist, we'll try to
627 * tweak any dest-relative paths to make them work for a dry-run (the
628 * destination dir must be in curr_dir[] when this function is called).
629 * We also warn about any arg that is non-existent or not a directory. */
630 static void check_alt_basis_dirs(void)
633 char **dir_p, *slash = strrchr(curr_dir, '/');
635 for (dir_p = basis_dir; *dir_p; dir_p++) {
636 if (dry_run > 1 && **dir_p != '/') {
637 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
638 char *new = new_array(char, len);
640 out_of_memory("check_alt_basis_dirs");
641 if (slash && strncmp(*dir_p, "../", 3) == 0) {
642 /* We want to remove only one leading "../" prefix for
643 * the directory we couldn't create in dry-run mode:
644 * this ensures that any other ".." references get
645 * evaluated the same as they would for a live copy. */
647 pathjoin(new, len, curr_dir, *dir_p + 3);
650 pathjoin(new, len, curr_dir, *dir_p);
653 if (do_stat(*dir_p, &st) < 0) {
654 rprintf(FWARNING, "%s arg does not exist: %s\n",
655 dest_option, *dir_p);
656 } else if (!S_ISDIR(st.st_mode)) {
657 rprintf(FWARNING, "%s arg is not a dir: %s\n",
658 dest_option, *dir_p);
663 /* This is only called by the sender. */
664 static void read_final_goodbye(int f_in)
668 char xname[MAXPATHLEN];
670 if (protocol_version < 29)
673 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
678 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
680 exit_cleanup(RERR_PROTOCOL);
684 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
686 struct file_list *flist;
689 if (DEBUG_GTE(SEND, 1)) {
690 rprintf(FINFO, "server_sender starting pid=%ld\n",
694 if (am_daemon && lp_write_only(module_id)) {
695 rprintf(FERROR, "ERROR: module is write only\n");
696 exit_cleanup(RERR_SYNTAX);
699 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
701 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
702 remove_source_files == 1 ? "source" : "sent");
703 exit_cleanup(RERR_SYNTAX);
707 if (!relative_paths) {
708 if (!change_dir(dir, CD_NORMAL)) {
709 rsyserr(FERROR, errno, "change_dir#3 %s failed",
711 exit_cleanup(RERR_FILESELECT);
717 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
723 flist = send_file_list(f_out,argc,argv);
724 if (!flist || flist->used == 0)
727 io_start_buffering_in(f_in);
729 send_files(f_in, f_out);
730 io_flush(FULL_FLUSH);
732 if (protocol_version >= 24)
733 read_final_goodbye(f_in);
734 io_flush(FULL_FLUSH);
739 static int do_recv(int f_in, int f_out, char *local_name)
745 /* The receiving side mustn't obey this, or an existing symlink that
746 * points to an identical file won't be replaced by the referent. */
747 copy_links = copy_dirlinks = copy_unsafe_links = 0;
749 #ifdef SUPPORT_HARD_LINKS
750 if (preserve_hard_links && !inc_recurse)
751 match_hard_links(first_flist);
754 if (fd_pair(error_pipe) < 0) {
755 rsyserr(FERROR, errno, "pipe failed in do_recv");
756 exit_cleanup(RERR_IPC);
759 io_flush(NORMAL_FLUSH);
761 if ((pid = do_fork()) == -1) {
762 rsyserr(FERROR, errno, "fork failed in do_recv");
763 exit_cleanup(RERR_IPC);
767 close(error_pipe[0]);
771 /* we can't let two processes write to the socket at one time */
772 io_end_multiplex_out();
774 /* set place to send errors */
775 set_msg_fd_out(error_pipe[1]);
776 io_start_buffering_out(error_pipe[1]);
778 recv_files(f_in, local_name);
779 io_flush(FULL_FLUSH);
782 if (output_needs_newline) {
784 output_needs_newline = 0;
787 send_msg(MSG_DONE, "", 1, 0);
788 write_varlong(error_pipe[1], stats.total_read, 3);
789 io_flush(FULL_FLUSH);
791 /* Handle any keep-alive packets from the post-processing work
792 * that the generator does. */
793 if (protocol_version >= 29) {
796 char xname[MAXPATHLEN];
798 kluge_around_eof = -1;
800 /* This should only get stopped via a USR2 signal. */
801 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
804 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
806 exit_cleanup(RERR_PROTOCOL);
809 /* Finally, we go to sleep until our parent kills us with a
810 * USR2 signal. We sleep for a short time, as on some OSes
811 * a signal won't interrupt a sleep! */
818 io_end_multiplex_in();
819 if (write_batch && !am_server)
822 close(error_pipe[1]);
826 io_start_buffering_out(f_out);
828 set_msg_fd_in(error_pipe[0]);
829 io_start_buffering_in(error_pipe[0]);
831 #ifdef SUPPORT_HARD_LINKS
832 if (preserve_hard_links && inc_recurse) {
833 struct file_list *flist;
834 for (flist = first_flist; flist; flist = flist->next)
835 match_hard_links(flist);
839 generate_files(f_out, local_name);
842 io_flush(FULL_FLUSH);
843 if (protocol_version >= 24) {
844 /* send a final goodbye message */
845 write_ndx(f_out, NDX_DONE);
847 io_flush(FULL_FLUSH);
851 wait_process_with_flush(pid, &exit_code);
855 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
858 struct file_list *flist;
859 char *local_name = NULL;
862 if (filesfrom_fd >= 0 && !msgs2stderr) {
863 /* We can't mix messages with files-from data on the socket,
864 * so temporarily turn off info/debug messages. */
865 negate_output_levels();
870 if (DEBUG_GTE(RECV, 1)) {
871 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
872 argc, (long)getpid());
875 if (am_daemon && lp_read_only(module_id)) {
876 rprintf(FERROR,"ERROR: module is read only\n");
877 exit_cleanup(RERR_SYNTAX);
885 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
886 rsyserr(FERROR, errno, "change_dir#4 %s failed",
888 exit_cleanup(RERR_FILESELECT);
892 if (protocol_version >= 30)
893 io_start_multiplex_in();
895 io_start_buffering_in(f_in);
896 recv_filter_list(f_in);
898 if (filesfrom_fd >= 0) {
899 /* We need to send the files-from names to the sender at the
900 * same time that we receive the file-list from them, so we
901 * need the IO routines to automatically write out the names
902 * onto our f_out socket as we read the file-list. This
903 * avoids both deadlock and extra delays/buffers. */
904 io_set_filesfrom_fds(filesfrom_fd, f_out);
908 flist = recv_file_list(f_in);
910 rprintf(FERROR,"server_recv: recv_file_list error\n");
911 exit_cleanup(RERR_FILESELECT);
913 if (inc_recurse && file_total == 1)
914 recv_additional_file_list(f_in);
917 negate_output_levels();
920 local_name = get_local_name(flist,argv[0]);
922 /* Now that we know what our destination directory turned out to be,
923 * we can sanitize the --link-/copy-/compare-dest args correctly. */
924 if (sanitize_paths) {
926 for (dir_p = basis_dir; *dir_p; dir_p++)
927 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
929 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
931 check_alt_basis_dirs();
933 if (daemon_filter_list.head) {
935 struct filter_list_struct *elp = &daemon_filter_list;
937 for (dir_p = basis_dir; *dir_p; dir_p++) {
940 dir += module_dirlen;
941 if (check_filter(elp, FLOG, dir, 1) < 0)
942 goto options_rejected;
944 if (partial_dir && *partial_dir == '/'
945 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
948 "Your options have been rejected by the server.\n");
949 exit_cleanup(RERR_SYNTAX);
953 exit_code = do_recv(f_in, f_out, local_name);
954 exit_cleanup(exit_code);
958 int child_main(int argc, char *argv[])
960 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
965 void start_server(int f_in, int f_out, int argc, char *argv[])
967 set_nonblocking(f_in);
968 set_nonblocking(f_out);
970 io_set_sock_fds(f_in, f_out);
971 setup_protocol(f_out, f_in);
973 if (protocol_version >= 23)
974 io_start_multiplex_out();
977 keep_dirlinks = 0; /* Must be disabled on the sender. */
978 if (need_messages_from_generator)
979 io_start_multiplex_in();
980 recv_filter_list(f_in);
981 do_server_sender(f_in, f_out, argc, argv);
983 do_server_recv(f_in, f_out, argc, argv);
989 * This is called once the connection has been negotiated. It is used
990 * for rsyncd, remote-shell, and local connections.
992 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
994 struct file_list *flist = NULL;
995 int exit_code = 0, exit_code2 = 0;
996 char *local_name = NULL;
998 cleanup_child_pid = pid;
1000 set_nonblocking(f_in);
1001 set_nonblocking(f_out);
1004 io_set_sock_fds(f_in, f_out);
1005 setup_protocol(f_out,f_in);
1007 /* We set our stderr file handle to blocking because ssh might have
1008 * set it to non-blocking. This can be particularly troublesome if
1009 * stderr is a clone of stdout, because ssh would have set our stdout
1010 * to non-blocking at the same time (which can easily cause us to lose
1011 * output from our print statements). This kluge shouldn't cause ssh
1012 * any problems for how we use it. Note also that we delayed setting
1013 * this until after the above protocol setup so that we know for sure
1014 * that ssh is done twiddling its file descriptors. */
1015 set_blocking(STDERR_FILENO);
1018 keep_dirlinks = 0; /* Must be disabled on the sender. */
1021 && (log_format_has(stdout_format, 'C')
1022 || log_format_has(logfile_format, 'C')))
1023 sender_keeps_checksum = 1;
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);
1039 if (DEBUG_GTE(FLIST, 3))
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);
1052 if (DEBUG_GTE(EXIT, 2))
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();
1069 send_filter_list(read_batch ? -1 : f_out);
1071 if (filesfrom_fd >= 0) {
1072 io_set_filesfrom_fds(filesfrom_fd, f_out);
1076 if (write_batch && !am_server)
1077 start_write_batch(f_in);
1078 flist = recv_file_list(f_in);
1079 if (inc_recurse && file_total == 1)
1080 recv_additional_file_list(f_in);
1082 if (flist && flist->used > 0) {
1083 local_name = get_local_name(flist, argv[0]);
1085 check_alt_basis_dirs();
1087 exit_code2 = do_recv(f_in, f_out, local_name);
1094 if (DEBUG_GTE(RECV, 1))
1095 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1096 io_flush(FULL_FLUSH);
1097 wait_process_with_flush(pid, &exit_code);
1100 return MAX(exit_code, exit_code2);
1103 static int copy_argv(char *argv[])
1107 for (i = 0; argv[i]; i++) {
1108 if (!(argv[i] = strdup(argv[i]))) {
1109 rprintf (FERROR, "out of memory at %s(%d)\n",
1110 __FILE__, __LINE__);
1120 * Start a client for either type of remote connection. Work out
1121 * whether the arguments request a remote shell or rsyncd connection,
1122 * and call the appropriate connection function, then run_client.
1124 * Calls either start_socket_client (for sockets) or do_cmd and
1125 * client_run (for ssh).
1127 static int start_client(int argc, char *argv[])
1129 char *p, *shell_machine = NULL, *shell_user = NULL;
1136 /* Don't clobber argv[] so that ps(1) can still show the right
1138 if ((ret = copy_argv(argv)) != 0)
1141 if (!read_batch) { /* for read_batch, NO source is specified */
1142 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1143 if (path) { /* source is remote */
1150 if (argc == 1 || **argv == ':')
1151 argc = 0; /* no dest arg */
1152 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1154 "The source and destination cannot both be remote.\n");
1155 exit_cleanup(RERR_SYNTAX);
1157 remote_argc--; /* don't count dest */
1160 if (filesfrom_host && *filesfrom_host
1161 && strcmp(filesfrom_host, shell_machine) != 0) {
1163 "--files-from hostname is not the same as the transfer hostname\n");
1164 exit_cleanup(RERR_SYNTAX);
1168 daemon_over_rsh = shell_cmd ? 1 : -1;
1169 } else { /* source is local, check dest arg */
1174 remote_argv = argv + argc;
1176 static char *dotarg[1] = { "." };
1178 remote_argv = dotarg;
1182 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1183 if (path && filesfrom_host && *filesfrom_host
1184 && strcmp(filesfrom_host, shell_machine) != 0) {
1186 "--files-from hostname is not the same as the transfer hostname\n");
1187 exit_cleanup(RERR_SYNTAX);
1189 if (!path) { /* no hostspec found, so src & dest are local */
1191 if (filesfrom_host) {
1193 "--files-from cannot be remote when the transfer is local\n");
1194 exit_cleanup(RERR_SYNTAX);
1196 shell_machine = NULL;
1197 } else { /* hostspec was found, so dest is remote */
1200 daemon_over_rsh = shell_cmd ? 1 : -1;
1203 } else { /* read_batch */
1205 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1206 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1207 exit_cleanup(RERR_SYNTAX);
1209 remote_argv = argv + argc - 1;
1215 int dummy_port = rsync_port;
1217 /* For local source, extra source args must not have hostspec. */
1218 for (i = 1; i < argc; i++) {
1219 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1220 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1221 exit_cleanup(RERR_SYNTAX);
1226 int dummy_port = rsync_port;
1228 /* For remote source, any extra source args must have either
1229 * the same hostname or an empty hostname. */
1230 for (i = 1; i < remote_argc; i++) {
1231 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1233 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1234 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1235 exit_cleanup(RERR_SYNTAX);
1237 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1238 rprintf(FERROR, "All source args must come from the same machine.\n");
1239 exit_cleanup(RERR_SYNTAX);
1241 if (rsync_port != dummy_port) {
1242 if (!rsync_port || !dummy_port)
1243 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1245 rprintf(FERROR, "All source args must use the same port number.\n");
1246 exit_cleanup(RERR_SYNTAX);
1248 remote_argv[i] = arg;
1252 if (daemon_over_rsh < 0)
1253 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1255 if (password_file && !daemon_over_rsh) {
1256 rprintf(FERROR, "The --password-file option may only be "
1257 "used when accessing an rsync daemon.\n");
1258 exit_cleanup(RERR_SYNTAX);
1261 if (connect_timeout) {
1262 rprintf(FERROR, "The --contimeout option may only be "
1263 "used when connecting to an rsync daemon.\n");
1264 exit_cleanup(RERR_SYNTAX);
1267 if (shell_machine) {
1268 p = strrchr(shell_machine,'@');
1271 shell_user = shell_machine;
1272 shell_machine = p+1;
1276 if (DEBUG_GTE(CMD, 2)) {
1277 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1278 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1279 remote_argv ? NS(remote_argv[0]) : "");
1282 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1285 /* if we're running an rsync server on the remote host over a
1286 * remote shell command, we need to do the RSYNCD protocol first */
1287 if (daemon_over_rsh) {
1289 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1294 ret = client_run(f_in, f_out, pid, argc, argv);
1303 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1305 exit_cleanup(RERR_SIGNAL1);
1308 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1314 _exit(RERR_PARTIAL);
1318 RETSIGTYPE remember_children(UNUSED(int val))
1323 /* An empty waitpid() loop was put here by Tridge and we could never
1324 * get him to explain why he put it in, so rather than taking it
1325 * out we're instead saving the child exit statuses for later use.
1326 * The waitpid() loop presumably eliminates all possibility of leaving
1327 * zombie children, maybe that's why he did it. */
1328 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1329 /* save the child's exit status */
1330 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1331 if (pid_stat_table[cnt].pid == 0) {
1332 pid_stat_table[cnt].pid = pid;
1333 pid_stat_table[cnt].status = status;
1339 #ifndef HAVE_SIGACTION
1340 signal(SIGCHLD, remember_children);
1346 * This routine catches signals and tries to send them to gdb.
1348 * Because it's called from inside a signal handler it ought not to
1349 * use too many library routines.
1351 * @todo Perhaps use "screen -X" instead/as well, to help people
1352 * debugging without easy access to X. Perhaps use an environment
1353 * variable, or just call a script?
1355 * @todo The /proc/ magic probably only works on Linux (and
1356 * Solaris?) Can we be more portable?
1358 #ifdef MAINTAINER_MODE
1359 const char *get_panic_action(void)
1361 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1366 return "xterm -display :0 -T Panic -n Panic "
1367 "-e gdb /proc/%d/exe %d";
1372 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1374 * This signal handler is only installed if we were configured with
1375 * --enable-maintainer-mode. Perhaps it should always be on and we
1376 * should just look at the environment variable, but I'm a bit leery
1377 * of a signal sending us into a busy loop.
1379 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1384 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1385 getpid(), getpid());
1387 /* Unless we failed to execute gdb, we allow the process to
1388 * continue. I'm not sure if that's right. */
1389 ret = system(cmd_buf);
1396 int main(int argc,char *argv[])
1399 int orig_argc = argc;
1400 char **orig_argv = argv;
1401 #ifdef HAVE_SIGACTION
1402 # ifdef HAVE_SIGPROCMASK
1405 sigemptyset(&sigmask);
1407 sigact.sa_flags = SA_NOCLDSTOP;
1409 SIGACTMASK(SIGUSR1, sigusr1_handler);
1410 SIGACTMASK(SIGUSR2, sigusr2_handler);
1411 SIGACTMASK(SIGCHLD, remember_children);
1412 #ifdef MAINTAINER_MODE
1413 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1414 SIGACTMASK(SIGFPE, rsync_panic_handler);
1415 SIGACTMASK(SIGABRT, rsync_panic_handler);
1416 SIGACTMASK(SIGBUS, rsync_panic_handler);
1419 starttime = time(NULL);
1421 am_root = our_uid == 0;
1423 memset(&stats, 0, sizeof(stats));
1427 exit_cleanup(RERR_SYNTAX);
1430 /* we set a 0 umask so that correct file permissions can be
1432 orig_umask = umask(0);
1434 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1435 setlocale(LC_CTYPE, "");
1438 if (!parse_arguments(&argc, (const char ***) &argv)) {
1439 /* FIXME: We ought to call the same error-handling
1440 * code here, rather than relying on getopt. */
1442 exit_cleanup(RERR_SYNTAX);
1445 SIGACTMASK(SIGINT, sig_int);
1446 SIGACTMASK(SIGHUP, sig_int);
1447 SIGACTMASK(SIGTERM, sig_int);
1448 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1449 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1452 /* Ignore SIGPIPE; we consistently check error codes and will
1454 SIGACTION(SIGPIPE, SIG_IGN);
1456 SIGACTION(SIGXFSZ, SIG_IGN);
1459 /* Initialize change_dir() here because on some old systems getcwd
1460 * (implemented by forking "pwd" and reading its output) doesn't
1461 * work when there are other child processes. Also, on all systems
1462 * that implement getcwd that way "pwd" can't be found after chroot. */
1463 change_dir(NULL, CD_NORMAL);
1467 if ((write_batch || read_batch) && !am_server) {
1469 write_batch_shell_file(orig_argc, orig_argv, argc);
1471 if (read_batch && strcmp(batch_name, "-") == 0)
1472 batch_fd = STDIN_FILENO;
1474 batch_fd = do_open(batch_name,
1475 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1476 : O_RDONLY, S_IRUSR | S_IWUSR);
1479 rsyserr(FERROR, errno, "Batch file %s open error",
1480 full_fname(batch_name));
1481 exit_cleanup(RERR_FILEIO);
1484 read_stream_flags(batch_fd);
1486 write_stream_flags(batch_fd);
1488 if (write_batch < 0)
1495 } else if (am_daemon)
1496 return daemon_main();
1498 if (am_server && protect_args) {
1499 char buf[MAXPATHLEN];
1501 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1502 if (!parse_arguments(&argc, (const char ***) &argv)) {
1504 exit_cleanup(RERR_SYNTAX);
1510 exit_cleanup(RERR_SYNTAX);
1514 set_nonblocking(STDIN_FILENO);
1515 set_nonblocking(STDOUT_FILENO);
1517 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1518 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1521 ret = start_client(argc, argv);
1523 exit_cleanup(RERR_STARTCLIENT);