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, 2004, 2005, 2006 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 2 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, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
25 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
35 extern int am_generator;
37 extern int blocking_io;
38 extern int remove_source_files;
39 extern int daemon_over_rsh;
40 extern int need_messages_from_generator;
41 extern int kluge_around_eof;
43 extern int log_got_error;
45 extern int copy_links;
46 extern int copy_dirlinks;
47 extern int keep_dirlinks;
48 extern int preserve_hard_links;
49 extern int protocol_version;
51 extern int relative_paths;
52 extern int sanitize_paths;
53 extern int curr_dir_depth;
54 extern int curr_dir_len;
56 extern int rsync_port;
57 extern int whole_file;
58 extern int read_batch;
59 extern int write_batch;
61 extern int batch_gen_fd;
62 extern int filesfrom_fd;
63 extern pid_t cleanup_child_pid;
64 extern struct stats stats;
65 extern char *filesfrom_host;
66 extern char *partial_dir;
67 extern char *basis_dir[];
68 extern char *rsync_path;
69 extern char *shell_cmd;
70 extern char *batch_name;
71 extern char *password_file;
72 extern char curr_dir[MAXPATHLEN];
73 extern struct filter_list_struct server_filter_list;
77 mode_t orig_umask = 0;
78 struct file_list *the_file_list;
80 /* There's probably never more than at most 2 outstanding child processes,
81 * but set it higher, just in case. */
82 #define MAXCHILDPROCS 7
85 # ifdef HAVE_SIGPROCMASK
86 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
88 # define SIGACTMASK(n,h) SIGACTION(n,h)
90 static struct sigaction sigact;
96 } pid_stat_table[MAXCHILDPROCS];
98 static time_t starttime, endtime;
99 static int64 total_read, total_written;
101 static void show_malloc_stats(void);
103 /* Works like waitpid(), but if we already harvested the child pid in our
104 * remember_children(), we succeed instead of returning an error. */
105 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
110 waited_pid = waitpid(pid, status_ptr, flags);
111 } while (waited_pid == -1 && errno == EINTR);
113 if (waited_pid == -1 && errno == ECHILD) {
114 /* Status of requested child no longer available: check to
115 * see if it was processed by remember_children(). */
117 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
118 if (pid == pid_stat_table[cnt].pid) {
119 *status_ptr = pid_stat_table[cnt].status;
120 pid_stat_table[cnt].pid = 0;
129 /* Wait for a process to exit, calling io_flush while waiting. */
130 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
135 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
137 io_flush(FULL_FLUSH);
140 /* TODO: If the child exited on a signal, then log an
141 * appropriate error message. Perhaps we should also accept a
142 * message describing the purpose of the child. Also indicate
143 * this to the caller so that they know something went wrong. */
144 if (waited_pid < 0) {
145 rsyserr(FERROR, errno, "waitpid");
146 *exit_code_ptr = RERR_WAITCHILD;
147 } else if (!WIFEXITED(status)) {
149 if (WCOREDUMP(status))
150 *exit_code_ptr = RERR_CRASHED;
153 if (WIFSIGNALED(status))
154 *exit_code_ptr = RERR_TERMINATED;
156 *exit_code_ptr = RERR_WAITCHILD;
158 *exit_code_ptr = WEXITSTATUS(status);
161 /* This function gets called from all 3 processes. We want the client side
162 * to actually output the text, but the sender is the only process that has
163 * all the stats we need. So, if we're a client sender, we do the report.
164 * If we're a server sender, we write the stats on the supplied fd. If
165 * we're the client receiver we read the stats from the supplied fd and do
166 * the report. All processes might also generate a set of debug stats, if
167 * the verbose level is high enough (this is the only thing that the
168 * generator process and the server receiver ever do here). */
169 static void handle_stats(int f)
171 endtime = time(NULL);
173 /* Cache two stats because the read/write code can change it. */
174 total_read = stats.total_read;
175 total_written = stats.total_written;
177 if (do_stats && verbose > 1) {
178 /* These come out from every process */
187 if (f == -1 || !am_sender)
193 write_longint(f, total_read);
194 write_longint(f, total_written);
195 write_longint(f, stats.total_size);
196 if (protocol_version >= 29) {
197 write_longint(f, stats.flist_buildtime);
198 write_longint(f, stats.flist_xfertime);
204 /* this is the client */
206 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
208 else if (!am_sender) {
209 /* Read the first two in opposite order because the meaning of
210 * read/write swaps when switching from sender to receiver. */
211 total_written = read_longint(f);
212 total_read = read_longint(f);
213 stats.total_size = read_longint(f);
214 if (protocol_version >= 29) {
215 stats.flist_buildtime = read_longint(f);
216 stats.flist_xfertime = read_longint(f);
218 } else if (write_batch) {
219 /* The --read-batch process is going to be a client
220 * receiver, so we need to give it the stats. */
221 write_longint(batch_fd, total_read);
222 write_longint(batch_fd, total_written);
223 write_longint(batch_fd, stats.total_size);
224 if (protocol_version >= 29) {
225 write_longint(batch_fd, stats.flist_buildtime);
226 write_longint(batch_fd, stats.flist_xfertime);
231 static void output_summary(void)
234 rprintf(FCLIENT, "\n");
235 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
236 rprintf(FINFO,"Number of files transferred: %d\n",
237 stats.num_transferred_files);
238 rprintf(FINFO,"Total file size: %s bytes\n",
239 human_num(stats.total_size));
240 rprintf(FINFO,"Total transferred file size: %s bytes\n",
241 human_num(stats.total_transferred_size));
242 rprintf(FINFO,"Literal data: %s bytes\n",
243 human_num(stats.literal_data));
244 rprintf(FINFO,"Matched data: %s bytes\n",
245 human_num(stats.matched_data));
246 rprintf(FINFO,"File list size: %s\n",
247 human_num(stats.flist_size));
248 if (stats.flist_buildtime) {
250 "File list generation time: %.3f seconds\n",
251 (double)stats.flist_buildtime / 1000);
253 "File list transfer time: %.3f seconds\n",
254 (double)stats.flist_xfertime / 1000);
256 rprintf(FINFO,"Total bytes sent: %s\n",
257 human_num(total_written));
258 rprintf(FINFO,"Total bytes received: %s\n",
259 human_num(total_read));
262 if (verbose || do_stats) {
263 rprintf(FCLIENT, "\n");
265 "sent %s bytes received %s bytes %s bytes/sec\n",
266 human_num(total_written), human_num(total_read),
267 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
268 rprintf(FINFO, "total size is %s speedup is %.2f\n",
269 human_num(stats.total_size),
270 (double)stats.total_size / (total_written+total_read));
279 * If our C library can get malloc statistics, then show them to FINFO
281 static void show_malloc_stats(void)
288 rprintf(FCLIENT, "\n");
289 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
290 getpid(), am_server ? "server " : "",
291 am_daemon ? "daemon " : "", who_am_i());
292 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
294 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
296 rprintf(FINFO, " smblks: %10ld\n",
298 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
300 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
302 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
303 (long)mi.arena + mi.hblkhd);
304 rprintf(FINFO, " usmblks: %10ld\n",
306 rprintf(FINFO, " fsmblks: %10ld\n",
308 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
310 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
312 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
314 #endif /* HAVE_MALLINFO */
318 /* Start the remote shell. cmd may be NULL to use the default. */
319 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
320 int *f_in, int *f_out)
323 char *args[MAX_ARGS];
328 if (!read_batch && !local_server) {
329 char *t, *f, in_quote = '\0';
330 char *rsh_env = getenv(RSYNC_RSH_ENV);
339 for (t = f = cmd; *f; f++) {
342 /* Comparison leaves rooms for server_options(). */
343 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
344 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
345 exit_cleanup(RERR_SYNTAX);
348 while (*f != ' ' || in_quote) {
352 "Missing trailing-%c in remote-shell command.\n",
354 exit_cleanup(RERR_SYNTAX);
359 if (*f == '\'' || *f == '"') {
364 if (*f == in_quote && *++f != in_quote) {
374 /* check to see if we've already been given '-l user' in
375 * the remote-shell command */
376 for (i = 0; i < argc-1; i++) {
377 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
382 /* remsh (on HPUX) takes the arguments the other way around */
383 args[argc++] = machine;
384 if (user && !(daemon_over_rsh && dash_l_set)) {
389 if (user && !(daemon_over_rsh && dash_l_set)) {
393 args[argc++] = machine;
396 args[argc++] = rsync_path;
398 if (blocking_io < 0) {
400 if ((cp = strrchr(cmd, '/')) != NULL)
404 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
408 server_options(args,&argc);
410 if (argc >= MAX_ARGS - 2) {
411 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
412 exit_cleanup(RERR_SYNTAX);
418 if (!daemon_over_rsh && path && *path)
424 for (i = 0; i < argc; i++)
425 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
426 rprintf(FCLIENT, "\n");
430 int from_gen_pipe[2];
431 if (fd_pair(from_gen_pipe) < 0) {
432 rsyserr(FERROR, errno, "pipe");
433 exit_cleanup(RERR_IPC);
435 batch_gen_fd = from_gen_pipe[0];
436 *f_out = from_gen_pipe[1];
438 ret = -1; /* no child pid */
439 } else if (local_server) {
440 /* If the user didn't request --[no-]whole-file, force
441 * it on, but only if we're not batch processing. */
442 if (whole_file < 0 && !write_batch)
444 ret = local_child(argc, args, f_in, f_out, child_main);
446 ret = piped_child(args,f_in,f_out);
454 out_of_memory("do_cmd");
455 return 0; /* not reached */
458 /* The receiving side operates in one of two modes:
460 * 1. it receives any number of files into a destination directory,
461 * placing them according to their names in the file-list.
463 * 2. it receives a single file and saves it using the name in the
464 * destination path instead of its file-list name. This requires a
465 * "local name" for writing out the destination file.
467 * So, our task is to figure out what mode/local-name we need.
468 * For mode 1, we change into the destination directory and return NULL.
469 * For mode 2, we change into the directory containing the destination
470 * file (if we aren't already there) and return the local-name. */
471 static char *get_local_name(struct file_list *flist, char *dest_path)
478 rprintf(FINFO, "get_local_name count=%d %s\n",
479 flist->count, NS(dest_path));
482 if (!dest_path || list_only)
485 /* See what currently exists at the destination. */
486 if ((statret = do_stat(dest_path, &st)) == 0) {
487 /* If the destination is a dir, enter it and use mode 1. */
488 if (S_ISDIR(st.st_mode)) {
489 if (!push_dir(dest_path, 0)) {
490 rsyserr(FERROR, errno, "push_dir#1 %s failed",
491 full_fname(dest_path));
492 exit_cleanup(RERR_FILESELECT);
496 if (flist->count > 1) {
498 "ERROR: destination must be a directory when"
499 " copying more than 1 file\n");
500 exit_cleanup(RERR_FILESELECT);
502 /* Caution: flist->count could be 0! */
503 if (flist->count == 1 && S_ISDIR(flist->files[0]->mode)) {
505 "ERROR: cannot overwrite non-directory"
506 " with a directory\n");
507 exit_cleanup(RERR_FILESELECT);
509 } else if (errno != ENOENT) {
510 /* If we don't know what's at the destination, fail. */
511 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
512 full_fname(dest_path));
513 exit_cleanup(RERR_FILESELECT);
516 cp = strrchr(dest_path, '/');
518 /* If we need a destination directory because the transfer is not
519 * of a single non-directory or the user has requested one via a
520 * destination path ending in a slash, create one and use mode 1. */
521 if (flist->count > 1 || (cp && !cp[1])) {
522 /* Lop off the final slash (if any). */
528 "ERROR: destination path is not a directory\n");
529 exit_cleanup(RERR_SYNTAX);
532 if (mkdir_defmode(dest_path) != 0) {
533 rsyserr(FERROR, errno, "mkdir %s failed",
534 full_fname(dest_path));
535 exit_cleanup(RERR_FILEIO);
541 rprintf(FINFO, "created directory %s\n", dest_path);
544 /* Indicate that dest dir doesn't really exist. */
548 if (!push_dir(dest_path, dry_run > 1)) {
549 rsyserr(FERROR, errno, "push_dir#2 %s failed",
550 full_fname(dest_path));
551 exit_cleanup(RERR_FILESELECT);
557 /* Otherwise, we are writing a single file, possibly on top of an
558 * existing non-directory. Change to the item's parent directory
559 * (if it has a path component), return the basename of the
560 * destination file as the local name, and use mode 2. */
568 if (!push_dir(dest_path, 0)) {
569 rsyserr(FERROR, errno, "push_dir#3 %s failed",
570 full_fname(dest_path));
571 exit_cleanup(RERR_FILESELECT);
578 /* Call this if the destination dir (which is assumed to be in curr_dir)
579 * does not yet exist and we can't create it due to being in dry-run
580 * mode. We'll fix dirs that can be relative to the non-existent dir. */
581 static void fix_basis_dirs(void)
583 char **dir, *new, *slash;
589 slash = strrchr(curr_dir, '/');
591 for (dir = basis_dir; *dir; dir++) {
594 len = curr_dir_len + 1 + strlen(*dir) + 1;
595 if (!(new = new_array(char, len)))
596 out_of_memory("fix_basis_dirs");
597 if (slash && strncmp(*dir, "../", 3) == 0) {
598 /* We want to remove only one leading "../" prefix for
599 * the directory we couldn't create in dry-run mode:
600 * this ensures that any other ".." references get
601 * evaluated the same as they would for a live copy. */
603 pathjoin(new, len, curr_dir, *dir + 3);
606 pathjoin(new, len, curr_dir, *dir);
611 /* This is only called by the sender. */
612 static void read_final_goodbye(int f_in, int f_out)
616 if (protocol_version < 29)
619 while ((i = read_int(f_in)) == the_file_list->count
620 && read_shortint(f_in) == ITEM_IS_NEW) {
621 /* Forward the keep-alive (no-op) to the receiver. */
622 write_int(f_out, the_file_list->count);
623 write_shortint(f_out, ITEM_IS_NEW);
628 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
630 exit_cleanup(RERR_PROTOCOL);
634 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
636 struct file_list *flist;
640 rprintf(FINFO, "server_sender starting pid=%ld\n",
644 if (am_daemon && lp_write_only(module_id)) {
645 rprintf(FERROR, "ERROR: module is write only\n");
646 exit_cleanup(RERR_SYNTAX);
649 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
651 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
652 remove_source_files == 1 ? "source" : "sent");
653 exit_cleanup(RERR_SYNTAX);
657 if (!relative_paths) {
658 if (!push_dir(dir, 0)) {
659 rsyserr(FERROR, errno, "push_dir#3 %s failed",
661 exit_cleanup(RERR_FILESELECT);
667 if (argc == 0 && (recurse || list_only)) {
673 flist = send_file_list(f_out,argc,argv);
674 if (!flist || flist->count == 0)
676 the_file_list = flist;
678 io_start_buffering_in();
679 io_start_buffering_out();
681 send_files(flist,f_out,f_in);
682 io_flush(FULL_FLUSH);
684 if (protocol_version >= 24)
685 read_final_goodbye(f_in, f_out);
686 io_flush(FULL_FLUSH);
691 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
697 /* The receiving side mustn't obey this, or an existing symlink that
698 * points to an identical file won't be replaced by the referent. */
699 copy_links = copy_dirlinks = 0;
701 #ifdef SUPPORT_HARD_LINKS
702 if (preserve_hard_links)
706 if (fd_pair(error_pipe) < 0) {
707 rsyserr(FERROR, errno, "pipe failed in do_recv");
708 exit_cleanup(RERR_IPC);
711 io_flush(NORMAL_FLUSH);
713 if ((pid = do_fork()) == -1) {
714 rsyserr(FERROR, errno, "fork failed in do_recv");
715 exit_cleanup(RERR_IPC);
719 close(error_pipe[0]);
723 /* we can't let two processes write to the socket at one time */
724 close_multiplexing_out();
726 /* set place to send errors */
727 set_msg_fd_out(error_pipe[1]);
729 recv_files(f_in, flist, local_name);
730 io_flush(FULL_FLUSH);
733 send_msg(MSG_DONE, "", 0);
734 io_flush(FULL_FLUSH);
736 /* Handle any keep-alive packets from the post-processing work
737 * that the generator does. */
738 if (protocol_version >= 29) {
739 kluge_around_eof = -1;
741 /* This should only get stopped via a USR2 signal. */
742 while (read_int(f_in) == flist->count
743 && read_shortint(f_in) == ITEM_IS_NEW) {}
745 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
747 exit_cleanup(RERR_PROTOCOL);
750 /* Finally, we go to sleep until our parent kills us with a
751 * USR2 signal. We sleep for a short time, as on some OSes
752 * a signal won't interrupt a sleep! */
758 close_multiplexing_in();
759 if (write_batch && !am_server)
762 close(error_pipe[1]);
766 io_start_buffering_out();
768 set_msg_fd_in(error_pipe[0]);
770 generate_files(f_out, flist, local_name);
773 io_flush(FULL_FLUSH);
774 if (protocol_version >= 24) {
775 /* send a final goodbye message */
776 write_int(f_out, NDX_DONE);
778 io_flush(FULL_FLUSH);
782 wait_process_with_flush(pid, &exit_code);
786 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
789 struct file_list *flist;
790 char *local_name = NULL;
792 int save_verbose = verbose;
794 if (filesfrom_fd >= 0) {
795 /* We can't mix messages with files-from data on the socket,
796 * so temporarily turn off verbose messages. */
801 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
802 argc, (long)getpid());
805 if (am_daemon && lp_read_only(module_id)) {
806 rprintf(FERROR,"ERROR: module is read only\n");
807 exit_cleanup(RERR_SYNTAX);
815 if (!am_daemon && !push_dir(dir, 0)) {
816 rsyserr(FERROR, errno, "push_dir#4 %s failed",
818 exit_cleanup(RERR_FILESELECT);
822 io_start_buffering_in();
823 recv_filter_list(f_in);
825 if (filesfrom_fd >= 0) {
826 /* We need to send the files-from names to the sender at the
827 * same time that we receive the file-list from them, so we
828 * need the IO routines to automatically write out the names
829 * onto our f_out socket as we read the file-list. This
830 * avoids both deadlock and extra delays/buffers. */
831 io_set_filesfrom_fds(filesfrom_fd, f_out);
835 flist = recv_file_list(f_in);
836 verbose = save_verbose;
838 rprintf(FERROR,"server_recv: recv_file_list error\n");
839 exit_cleanup(RERR_FILESELECT);
841 the_file_list = flist;
844 local_name = get_local_name(flist,argv[0]);
846 /* Now that we know what our destination directory turned out to be,
847 * we can sanitize the --link-/copy-/compare-dest args correctly. */
848 if (sanitize_paths) {
850 for (dir = basis_dir; *dir; dir++) {
851 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
854 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
859 if (server_filter_list.head) {
861 struct filter_list_struct *elp = &server_filter_list;
863 for (dir = basis_dir; *dir; dir++) {
864 if (check_filter(elp, *dir, 1) < 0)
865 goto options_rejected;
867 if (partial_dir && *partial_dir == '/'
868 && check_filter(elp, partial_dir, 1) < 0) {
871 "Your options have been rejected by the server.\n");
872 exit_cleanup(RERR_SYNTAX);
876 exit_code = do_recv(f_in,f_out,flist,local_name);
877 exit_cleanup(exit_code);
881 int child_main(int argc, char *argv[])
883 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
888 void start_server(int f_in, int f_out, int argc, char *argv[])
890 set_nonblocking(f_in);
891 set_nonblocking(f_out);
893 io_set_sock_fds(f_in, f_out);
894 setup_protocol(f_out, f_in);
895 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
899 if (protocol_version >= 23)
900 io_start_multiplex_out();
903 keep_dirlinks = 0; /* Must be disabled on the sender. */
904 if (need_messages_from_generator)
905 io_start_multiplex_in();
906 recv_filter_list(f_in);
907 do_server_sender(f_in, f_out, argc, argv);
909 do_server_recv(f_in, f_out, argc, argv);
915 * This is called once the connection has been negotiated. It is used
916 * for rsyncd, remote-shell, and local connections.
918 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
920 struct file_list *flist = NULL;
921 int exit_code = 0, exit_code2 = 0;
922 char *local_name = NULL;
924 cleanup_child_pid = pid;
926 set_nonblocking(f_in);
927 set_nonblocking(f_out);
930 io_set_sock_fds(f_in, f_out);
931 setup_protocol(f_out,f_in);
932 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
936 if (protocol_version >= 23 && !read_batch)
937 io_start_multiplex_in();
939 /* We set our stderr file handle to blocking because ssh might have
940 * set it to non-blocking. This can be particularly troublesome if
941 * stderr is a clone of stdout, because ssh would have set our stdout
942 * to non-blocking at the same time (which can easily cause us to lose
943 * output from our print statements). This kluge shouldn't cause ssh
944 * any problems for how we use it. Note also that we delayed setting
945 * this until after the above protocol setup so that we know for sure
946 * that ssh is done twiddling its file descriptors. */
947 set_blocking(STDERR_FILENO);
950 keep_dirlinks = 0; /* Must be disabled on the sender. */
951 io_start_buffering_out();
954 send_filter_list(f_out);
958 if (write_batch && !am_server)
959 start_write_batch(f_out);
960 flist = send_file_list(f_out, argc, argv);
963 rprintf(FINFO,"file list sent\n");
964 the_file_list = flist;
966 io_flush(NORMAL_FLUSH);
967 send_files(flist,f_out,f_in);
968 io_flush(FULL_FLUSH);
970 if (protocol_version >= 24)
971 read_final_goodbye(f_in, f_out);
974 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
975 io_flush(FULL_FLUSH);
976 wait_process_with_flush(pid, &exit_code);
979 io_flush(FULL_FLUSH);
980 exit_cleanup(exit_code);
983 if (need_messages_from_generator && !read_batch)
984 io_start_multiplex_out();
989 send_filter_list(read_batch ? -1 : f_out);
991 if (filesfrom_fd >= 0) {
992 io_set_filesfrom_fds(filesfrom_fd, f_out);
996 if (write_batch && !am_server)
997 start_write_batch(f_in);
998 flist = recv_file_list(f_in);
999 the_file_list = flist;
1001 if (flist && flist->count > 0) {
1002 local_name = get_local_name(flist, argv[0]);
1006 exit_code2 = do_recv(f_in, f_out, flist, local_name);
1014 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1015 io_flush(FULL_FLUSH);
1016 wait_process_with_flush(pid, &exit_code);
1019 return MAX(exit_code, exit_code2);
1022 static int copy_argv(char *argv[])
1026 for (i = 0; argv[i]; i++) {
1027 if (!(argv[i] = strdup(argv[i]))) {
1028 rprintf (FERROR, "out of memory at %s(%d)\n",
1029 __FILE__, __LINE__);
1039 * Start a client for either type of remote connection. Work out
1040 * whether the arguments request a remote shell or rsyncd connection,
1041 * and call the appropriate connection function, then run_client.
1043 * Calls either start_socket_client (for sockets) or do_cmd and
1044 * client_run (for ssh).
1046 static int start_client(int argc, char *argv[])
1049 char *shell_machine = NULL;
1050 char *shell_path = NULL;
1051 char *shell_user = NULL;
1057 /* Don't clobber argv[] so that ps(1) can still show the right
1059 if ((rc = copy_argv(argv)))
1062 if (!read_batch) { /* for read_batch, NO source is specified */
1063 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1064 if (shell_path) { /* source is remote */
1068 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1070 "The source and destination cannot both be remote.\n");
1071 exit_cleanup(RERR_SYNTAX);
1074 if (filesfrom_host && *filesfrom_host
1075 && strcmp(filesfrom_host, shell_machine) != 0) {
1077 "--files-from hostname is not the same as the transfer hostname\n");
1078 exit_cleanup(RERR_SYNTAX);
1082 return start_socket_client(shell_machine,
1086 daemon_over_rsh = 1;
1090 } else { /* source is local, check dest arg */
1100 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1101 if (shell_path && filesfrom_host && *filesfrom_host
1102 && strcmp(filesfrom_host, shell_machine) != 0) {
1104 "--files-from hostname is not the same as the transfer hostname\n");
1105 exit_cleanup(RERR_SYNTAX);
1107 if (!shell_path) { /* no hostspec found, so src & dest are local */
1109 if (filesfrom_host) {
1111 "--files-from cannot be remote when the transfer is local\n");
1112 exit_cleanup(RERR_SYNTAX);
1114 shell_machine = NULL;
1116 } else if (rsync_port) {
1118 return start_socket_client(shell_machine,
1122 daemon_over_rsh = 1;
1125 } else { /* read_batch */
1127 shell_path = argv[argc-1];
1128 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1129 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1130 exit_cleanup(RERR_SYNTAX);
1134 if (password_file && !daemon_over_rsh) {
1135 rprintf(FERROR, "The --password-file option may only be "
1136 "used when accessing an rsync daemon.\n");
1137 exit_cleanup(RERR_SYNTAX);
1140 if (shell_machine) {
1141 p = strrchr(shell_machine,'@');
1144 shell_user = shell_machine;
1145 shell_machine = p+1;
1150 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1151 shell_cmd ? shell_cmd : "",
1152 shell_machine ? shell_machine : "",
1153 shell_user ? shell_user : "",
1154 shell_path ? shell_path : "");
1157 /* for remote source, only single dest arg can remain ... */
1158 if (!am_sender && argc > 1) {
1160 exit_cleanup(RERR_SYNTAX);
1163 /* ... or no dest at all */
1164 if (!am_sender && argc == 0)
1167 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1170 /* if we're running an rsync server on the remote host over a
1171 * remote shell command, we need to do the RSYNCD protocol first */
1172 if (daemon_over_rsh) {
1174 tmpret = start_inband_exchange(shell_user, shell_path,
1180 ret = client_run(f_in, f_out, pid, argc, argv);
1189 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1191 exit_cleanup(RERR_SIGNAL1);
1194 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1200 _exit(RERR_PARTIAL);
1204 RETSIGTYPE remember_children(UNUSED(int val))
1209 /* An empty waitpid() loop was put here by Tridge and we could never
1210 * get him to explain why he put it in, so rather than taking it
1211 * out we're instead saving the child exit statuses for later use.
1212 * The waitpid() loop presumably eliminates all possibility of leaving
1213 * zombie children, maybe that's why he did it. */
1214 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1215 /* save the child's exit status */
1216 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1217 if (pid_stat_table[cnt].pid == 0) {
1218 pid_stat_table[cnt].pid = pid;
1219 pid_stat_table[cnt].status = status;
1225 #ifndef HAVE_SIGACTION
1226 signal(SIGCHLD, remember_children);
1232 * This routine catches signals and tries to send them to gdb.
1234 * Because it's called from inside a signal handler it ought not to
1235 * use too many library routines.
1237 * @todo Perhaps use "screen -X" instead/as well, to help people
1238 * debugging without easy access to X. Perhaps use an environment
1239 * variable, or just call a script?
1241 * @todo The /proc/ magic probably only works on Linux (and
1242 * Solaris?) Can we be more portable?
1244 #ifdef MAINTAINER_MODE
1245 const char *get_panic_action(void)
1247 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1252 return "xterm -display :0 -T Panic -n Panic "
1253 "-e gdb /proc/%d/exe %d";
1258 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1260 * This signal handler is only installed if we were configured with
1261 * --enable-maintainer-mode. Perhaps it should always be on and we
1262 * should just look at the environment variable, but I'm a bit leery
1263 * of a signal sending us into a busy loop.
1265 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1270 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1271 getpid(), getpid());
1273 /* Unless we failed to execute gdb, we allow the process to
1274 * continue. I'm not sure if that's right. */
1275 ret = system(cmd_buf);
1282 int main(int argc,char *argv[])
1285 int orig_argc = argc;
1286 char **orig_argv = argv;
1287 #ifdef HAVE_SIGACTION
1288 # ifdef HAVE_SIGPROCMASK
1291 sigemptyset(&sigmask);
1293 sigact.sa_flags = SA_NOCLDSTOP;
1295 SIGACTMASK(SIGUSR1, sigusr1_handler);
1296 SIGACTMASK(SIGUSR2, sigusr2_handler);
1297 SIGACTMASK(SIGCHLD, remember_children);
1298 #ifdef MAINTAINER_MODE
1299 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1300 SIGACTMASK(SIGFPE, rsync_panic_handler);
1301 SIGACTMASK(SIGABRT, rsync_panic_handler);
1302 SIGACTMASK(SIGBUS, rsync_panic_handler);
1305 starttime = time(NULL);
1306 am_root = (MY_UID() == 0);
1308 memset(&stats, 0, sizeof(stats));
1312 exit_cleanup(RERR_SYNTAX);
1315 /* we set a 0 umask so that correct file permissions can be
1317 orig_umask = umask(0);
1319 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1320 setlocale(LC_CTYPE, "");
1323 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1324 /* FIXME: We ought to call the same error-handling
1325 * code here, rather than relying on getopt. */
1327 exit_cleanup(RERR_SYNTAX);
1330 SIGACTMASK(SIGINT, sig_int);
1331 SIGACTMASK(SIGHUP, sig_int);
1332 SIGACTMASK(SIGTERM, sig_int);
1333 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1334 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1337 /* Ignore SIGPIPE; we consistently check error codes and will
1339 SIGACTION(SIGPIPE, SIG_IGN);
1341 SIGACTION(SIGXFSZ, SIG_IGN);
1344 /* Initialize push_dir here because on some old systems getcwd
1345 * (implemented by forking "pwd" and reading its output) doesn't
1346 * work when there are other child processes. Also, on all systems
1347 * that implement getcwd that way "pwd" can't be found after chroot. */
1352 if ((write_batch || read_batch) && !am_server) {
1354 write_batch_shell_file(orig_argc, orig_argv, argc);
1356 if (read_batch && strcmp(batch_name, "-") == 0)
1357 batch_fd = STDIN_FILENO;
1359 batch_fd = do_open(batch_name,
1360 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1361 : O_RDONLY, S_IRUSR | S_IWUSR);
1364 rsyserr(FERROR, errno, "Batch file %s open error",
1365 full_fname(batch_name));
1366 exit_cleanup(RERR_FILEIO);
1369 read_stream_flags(batch_fd);
1371 write_stream_flags(batch_fd);
1374 if (write_batch < 0)
1377 if (am_daemon && !am_server)
1378 return daemon_main();
1382 exit_cleanup(RERR_SYNTAX);
1386 set_nonblocking(STDIN_FILENO);
1387 set_nonblocking(STDOUT_FILENO);
1389 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1390 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1393 ret = start_client(argc, argv);
1395 exit_cleanup(RERR_STARTCLIENT);