2 * The startup routines, including main(), for rsync.
4 * Copyright (C) 1996-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2003-2007 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, visit the http://fsf.org website.
25 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
35 extern int am_generator;
37 extern int inc_recurse;
38 extern int blocking_io;
39 extern int remove_source_files;
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;
50 extern int file_total;
52 extern int relative_paths;
53 extern int sanitize_paths;
54 extern int curr_dir_depth;
55 extern int curr_dir_len;
57 extern int rsync_port;
58 extern int whole_file;
59 extern int read_batch;
60 extern int write_batch;
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 file_list *cur_flist;
74 extern struct filter_list_struct server_filter_list;
78 int daemon_over_rsh = 0;
79 mode_t orig_umask = 0;
80 int batch_gen_fd = -1;
82 /* There's probably never more than at most 2 outstanding child processes,
83 * but set it higher, just in case. */
84 #define MAXCHILDPROCS 7
87 # ifdef HAVE_SIGPROCMASK
88 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
90 # define SIGACTMASK(n,h) SIGACTION(n,h)
92 static struct sigaction sigact;
98 } pid_stat_table[MAXCHILDPROCS];
100 static time_t starttime, endtime;
101 static int64 total_read, total_written;
103 static void show_malloc_stats(void);
105 /* Works like waitpid(), but if we already harvested the child pid in our
106 * remember_children(), we succeed instead of returning an error. */
107 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
112 waited_pid = waitpid(pid, status_ptr, flags);
113 } while (waited_pid == -1 && errno == EINTR);
115 if (waited_pid == -1 && errno == ECHILD) {
116 /* Status of requested child no longer available: check to
117 * see if it was processed by remember_children(). */
119 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
120 if (pid == pid_stat_table[cnt].pid) {
121 *status_ptr = pid_stat_table[cnt].status;
122 pid_stat_table[cnt].pid = 0;
131 /* Wait for a process to exit, calling io_flush while waiting. */
132 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
137 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
139 io_flush(FULL_FLUSH);
142 /* TODO: If the child exited on a signal, then log an
143 * appropriate error message. Perhaps we should also accept a
144 * message describing the purpose of the child. Also indicate
145 * this to the caller so that they know something went wrong. */
146 if (waited_pid < 0) {
147 rsyserr(FERROR, errno, "waitpid");
148 *exit_code_ptr = RERR_WAITCHILD;
149 } else if (!WIFEXITED(status)) {
151 if (WCOREDUMP(status))
152 *exit_code_ptr = RERR_CRASHED;
155 if (WIFSIGNALED(status))
156 *exit_code_ptr = RERR_TERMINATED;
158 *exit_code_ptr = RERR_WAITCHILD;
160 *exit_code_ptr = WEXITSTATUS(status);
163 /* This function gets called from all 3 processes. We want the client side
164 * to actually output the text, but the sender is the only process that has
165 * all the stats we need. So, if we're a client sender, we do the report.
166 * If we're a server sender, we write the stats on the supplied fd. If
167 * we're the client receiver we read the stats from the supplied fd and do
168 * the report. All processes might also generate a set of debug stats, if
169 * the verbose level is high enough (this is the only thing that the
170 * generator process and the server receiver ever do here). */
171 static void handle_stats(int f)
173 endtime = time(NULL);
175 /* Cache two stats because the read/write code can change it. */
176 total_read = stats.total_read;
177 total_written = stats.total_written;
179 if (do_stats && verbose > 1) {
180 /* These come out from every process */
189 if (f == -1 || !am_sender)
195 write_varlong30(f, total_read, 3);
196 write_varlong30(f, total_written, 3);
197 write_varlong30(f, stats.total_size, 3);
198 if (protocol_version >= 29) {
199 write_varlong30(f, stats.flist_buildtime, 3);
200 write_varlong30(f, stats.flist_xfertime, 3);
206 /* this is the client */
208 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
210 else if (!am_sender) {
211 /* Read the first two in opposite order because the meaning of
212 * read/write swaps when switching from sender to receiver. */
213 total_written = read_varlong30(f, 3);
214 total_read = read_varlong30(f, 3);
215 stats.total_size = read_varlong30(f, 3);
216 if (protocol_version >= 29) {
217 stats.flist_buildtime = read_varlong30(f, 3);
218 stats.flist_xfertime = read_varlong30(f, 3);
220 } else if (write_batch) {
221 /* The --read-batch process is going to be a client
222 * receiver, so we need to give it the stats. */
223 write_varlong30(batch_fd, total_read, 3);
224 write_varlong30(batch_fd, total_written, 3);
225 write_varlong30(batch_fd, stats.total_size, 3);
226 if (protocol_version >= 29) {
227 write_varlong30(batch_fd, stats.flist_buildtime, 3);
228 write_varlong30(batch_fd, stats.flist_xfertime, 3);
233 static void output_summary(void)
236 rprintf(FCLIENT, "\n");
237 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
238 rprintf(FINFO,"Number of files transferred: %d\n",
239 stats.num_transferred_files);
240 rprintf(FINFO,"Total file size: %s bytes\n",
241 human_num(stats.total_size));
242 rprintf(FINFO,"Total transferred file size: %s bytes\n",
243 human_num(stats.total_transferred_size));
244 rprintf(FINFO,"Literal data: %s bytes\n",
245 human_num(stats.literal_data));
246 rprintf(FINFO,"Matched data: %s bytes\n",
247 human_num(stats.matched_data));
248 rprintf(FINFO,"File list size: %s\n",
249 human_num(stats.flist_size));
250 if (stats.flist_buildtime) {
252 "File list generation time: %.3f seconds\n",
253 (double)stats.flist_buildtime / 1000);
255 "File list transfer time: %.3f seconds\n",
256 (double)stats.flist_xfertime / 1000);
258 rprintf(FINFO,"Total bytes sent: %s\n",
259 human_num(total_written));
260 rprintf(FINFO,"Total bytes received: %s\n",
261 human_num(total_read));
264 if (verbose || do_stats) {
265 rprintf(FCLIENT, "\n");
267 "sent %s bytes received %s bytes %s bytes/sec\n",
268 human_num(total_written), human_num(total_read),
269 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
270 rprintf(FINFO, "total size is %s speedup is %.2f\n",
271 human_num(stats.total_size),
272 (double)stats.total_size / (total_written+total_read));
281 * If our C library can get malloc statistics, then show them to FINFO
283 static void show_malloc_stats(void)
290 rprintf(FCLIENT, "\n");
291 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
292 getpid(), am_server ? "server " : "",
293 am_daemon ? "daemon " : "", who_am_i());
294 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
296 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
298 rprintf(FINFO, " smblks: %10ld\n",
300 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
302 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
304 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
305 (long)mi.arena + mi.hblkhd);
306 rprintf(FINFO, " usmblks: %10ld\n",
308 rprintf(FINFO, " fsmblks: %10ld\n",
310 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
312 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
314 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
316 #endif /* HAVE_MALLINFO */
320 /* Start the remote shell. cmd may be NULL to use the default. */
321 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
322 int *f_in, int *f_out)
325 char *args[MAX_ARGS];
330 if (!read_batch && !local_server) {
331 char *t, *f, in_quote = '\0';
332 char *rsh_env = getenv(RSYNC_RSH_ENV);
341 for (t = f = cmd; *f; f++) {
344 /* Comparison leaves rooms for server_options(). */
345 if (argc >= MAX_ARGS - MAX_SERVER_ARGS) {
346 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
347 exit_cleanup(RERR_SYNTAX);
350 while (*f != ' ' || in_quote) {
354 "Missing trailing-%c in remote-shell command.\n",
356 exit_cleanup(RERR_SYNTAX);
361 if (*f == '\'' || *f == '"') {
366 if (*f == in_quote && *++f != in_quote) {
376 /* check to see if we've already been given '-l user' in
377 * the remote-shell command */
378 for (i = 0; i < argc-1; i++) {
379 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
384 /* remsh (on HPUX) takes the arguments the other way around */
385 args[argc++] = machine;
386 if (user && !(daemon_over_rsh && dash_l_set)) {
391 if (user && !(daemon_over_rsh && dash_l_set)) {
395 args[argc++] = machine;
398 args[argc++] = rsync_path;
400 if (blocking_io < 0) {
402 if ((cp = strrchr(cmd, '/')) != NULL)
406 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
410 server_options(args,&argc);
412 if (argc >= MAX_ARGS - 2) {
413 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
414 exit_cleanup(RERR_SYNTAX);
420 if (!daemon_over_rsh && path && *path)
426 for (i = 0; i < argc; i++)
427 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
428 rprintf(FCLIENT, "\n");
432 int from_gen_pipe[2];
433 if (fd_pair(from_gen_pipe) < 0) {
434 rsyserr(FERROR, errno, "pipe");
435 exit_cleanup(RERR_IPC);
437 batch_gen_fd = from_gen_pipe[0];
438 *f_out = from_gen_pipe[1];
440 ret = -1; /* no child pid */
441 } else if (local_server) {
442 /* If the user didn't request --[no-]whole-file, force
443 * it on, but only if we're not batch processing. */
444 if (whole_file < 0 && !write_batch)
446 ret = local_child(argc, args, f_in, f_out, child_main);
448 ret = piped_child(args,f_in,f_out);
456 out_of_memory("do_cmd");
457 return 0; /* not reached */
460 /* The receiving side operates in one of two modes:
462 * 1. it receives any number of files into a destination directory,
463 * placing them according to their names in the file-list.
465 * 2. it receives a single file and saves it using the name in the
466 * destination path instead of its file-list name. This requires a
467 * "local name" for writing out the destination file.
469 * So, our task is to figure out what mode/local-name we need.
470 * For mode 1, we change into the destination directory and return NULL.
471 * For mode 2, we change into the directory containing the destination
472 * file (if we aren't already there) and return the local-name. */
473 static char *get_local_name(struct file_list *flist, char *dest_path)
480 rprintf(FINFO, "get_local_name count=%d %s\n",
481 file_total, NS(dest_path));
484 if (!dest_path || list_only)
487 /* See what currently exists at the destination. */
488 if ((statret = do_stat(dest_path, &st)) == 0) {
489 /* If the destination is a dir, enter it and use mode 1. */
490 if (S_ISDIR(st.st_mode)) {
491 if (!push_dir(dest_path, 0)) {
492 rsyserr(FERROR, errno, "push_dir#1 %s failed",
493 full_fname(dest_path));
494 exit_cleanup(RERR_FILESELECT);
498 if (file_total > 1) {
500 "ERROR: destination must be a directory when"
501 " copying more than 1 file\n");
502 exit_cleanup(RERR_FILESELECT);
504 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
506 "ERROR: cannot overwrite non-directory"
507 " with a directory\n");
508 exit_cleanup(RERR_FILESELECT);
510 } else if (errno != ENOENT) {
511 /* If we don't know what's at the destination, fail. */
512 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
513 full_fname(dest_path));
514 exit_cleanup(RERR_FILESELECT);
517 cp = strrchr(dest_path, '/');
519 /* If we need a destination directory because the transfer is not
520 * of a single non-directory or the user has requested one via a
521 * destination path ending in a slash, create one and use mode 1. */
522 if (file_total > 1 || (cp && !cp[1])) {
523 /* Lop off the final slash (if any). */
529 "ERROR: destination path is not a directory\n");
530 exit_cleanup(RERR_SYNTAX);
533 if (mkdir_defmode(dest_path) != 0) {
534 rsyserr(FERROR, errno, "mkdir %s failed",
535 full_fname(dest_path));
536 exit_cleanup(RERR_FILEIO);
542 rprintf(FINFO, "created directory %s\n", dest_path);
545 /* Indicate that dest dir doesn't really exist. */
549 if (!push_dir(dest_path, dry_run > 1)) {
550 rsyserr(FERROR, errno, "push_dir#2 %s failed",
551 full_fname(dest_path));
552 exit_cleanup(RERR_FILESELECT);
558 /* Otherwise, we are writing a single file, possibly on top of an
559 * existing non-directory. Change to the item's parent directory
560 * (if it has a path component), return the basename of the
561 * destination file as the local name, and use mode 2. */
569 if (!push_dir(dest_path, 0)) {
570 rsyserr(FERROR, errno, "push_dir#3 %s failed",
571 full_fname(dest_path));
572 exit_cleanup(RERR_FILESELECT);
579 /* Call this if the destination dir (which is assumed to be in curr_dir)
580 * does not yet exist and we can't create it due to being in dry-run
581 * mode. We'll fix dirs that can be relative to the non-existent dir. */
582 static void fix_basis_dirs(void)
584 char **dir, *new, *slash;
590 slash = strrchr(curr_dir, '/');
592 for (dir = basis_dir; *dir; dir++) {
595 len = curr_dir_len + 1 + strlen(*dir) + 1;
596 if (!(new = new_array(char, len)))
597 out_of_memory("fix_basis_dirs");
598 if (slash && strncmp(*dir, "../", 3) == 0) {
599 /* We want to remove only one leading "../" prefix for
600 * the directory we couldn't create in dry-run mode:
601 * this ensures that any other ".." references get
602 * evaluated the same as they would for a live copy. */
604 pathjoin(new, len, curr_dir, *dir + 3);
607 pathjoin(new, len, curr_dir, *dir);
612 /* This is only called by the sender. */
613 static void read_final_goodbye(int f_in)
617 char xname[MAXPATHLEN];
619 if (protocol_version < 29)
622 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
627 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
629 exit_cleanup(RERR_PROTOCOL);
633 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
635 struct file_list *flist;
639 rprintf(FINFO, "server_sender starting pid=%ld\n",
643 if (am_daemon && lp_write_only(module_id)) {
644 rprintf(FERROR, "ERROR: module is write only\n");
645 exit_cleanup(RERR_SYNTAX);
648 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
650 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
651 remove_source_files == 1 ? "source" : "sent");
652 exit_cleanup(RERR_SYNTAX);
656 if (!relative_paths) {
657 if (!push_dir(dir, 0)) {
658 rsyserr(FERROR, errno, "push_dir#3 %s failed",
660 exit_cleanup(RERR_FILESELECT);
666 if (argc == 0 && (recurse || list_only)) {
672 flist = send_file_list(f_out,argc,argv);
673 if (!flist || flist->used == 0)
676 io_start_buffering_in(f_in);
678 send_files(f_in, f_out);
679 io_flush(FULL_FLUSH);
681 if (protocol_version >= 24)
682 read_final_goodbye(f_in);
683 io_flush(FULL_FLUSH);
688 static int do_recv(int f_in, int f_out, char *local_name)
694 /* The receiving side mustn't obey this, or an existing symlink that
695 * points to an identical file won't be replaced by the referent. */
696 copy_links = copy_dirlinks = 0;
698 #ifdef SUPPORT_HARD_LINKS
699 if (preserve_hard_links && !inc_recurse)
700 match_hard_links(cur_flist);
703 if (fd_pair(error_pipe) < 0) {
704 rsyserr(FERROR, errno, "pipe failed in do_recv");
705 exit_cleanup(RERR_IPC);
708 io_flush(NORMAL_FLUSH);
710 if ((pid = do_fork()) == -1) {
711 rsyserr(FERROR, errno, "fork failed in do_recv");
712 exit_cleanup(RERR_IPC);
716 close(error_pipe[0]);
720 /* we can't let two processes write to the socket at one time */
721 io_end_multiplex_out();
723 /* set place to send errors */
724 set_msg_fd_out(error_pipe[1]);
725 io_start_buffering_out(error_pipe[1]);
727 recv_files(f_in, local_name);
728 io_flush(FULL_FLUSH);
731 send_msg(MSG_DONE, "", 1, 0);
732 write_varlong(error_pipe[1], stats.total_read, 3);
733 io_flush(FULL_FLUSH);
735 /* Handle any keep-alive packets from the post-processing work
736 * that the generator does. */
737 if (protocol_version >= 29) {
740 char xname[MAXPATHLEN];
742 kluge_around_eof = -1;
744 /* This should only get stopped via a USR2 signal. */
745 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
748 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
750 exit_cleanup(RERR_PROTOCOL);
753 /* Finally, we go to sleep until our parent kills us with a
754 * USR2 signal. We sleep for a short time, as on some OSes
755 * a signal won't interrupt a sleep! */
762 io_end_multiplex_in();
763 if (write_batch && !am_server)
766 close(error_pipe[1]);
770 io_start_buffering_out(f_out);
772 set_msg_fd_in(error_pipe[0]);
773 io_start_buffering_in(error_pipe[0]);
775 generate_files(f_out, local_name);
778 io_flush(FULL_FLUSH);
779 if (protocol_version >= 24) {
780 /* send a final goodbye message */
781 write_ndx(f_out, NDX_DONE);
783 io_flush(FULL_FLUSH);
787 wait_process_with_flush(pid, &exit_code);
791 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
794 struct file_list *flist;
795 char *local_name = NULL;
797 int save_verbose = verbose;
799 if (filesfrom_fd >= 0) {
800 /* We can't mix messages with files-from data on the socket,
801 * so temporarily turn off verbose messages. */
806 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
807 argc, (long)getpid());
810 if (am_daemon && lp_read_only(module_id)) {
811 rprintf(FERROR,"ERROR: module is read only\n");
812 exit_cleanup(RERR_SYNTAX);
820 if (!am_daemon && !push_dir(dir, 0)) {
821 rsyserr(FERROR, errno, "push_dir#4 %s failed",
823 exit_cleanup(RERR_FILESELECT);
827 if (protocol_version >= 30)
828 io_start_multiplex_in();
830 io_start_buffering_in(f_in);
831 recv_filter_list(f_in);
833 if (filesfrom_fd >= 0) {
834 /* We need to send the files-from names to the sender at the
835 * same time that we receive the file-list from them, so we
836 * need the IO routines to automatically write out the names
837 * onto our f_out socket as we read the file-list. This
838 * avoids both deadlock and extra delays/buffers. */
839 io_set_filesfrom_fds(filesfrom_fd, f_out);
843 flist = recv_file_list(f_in);
845 rprintf(FERROR,"server_recv: recv_file_list error\n");
846 exit_cleanup(RERR_FILESELECT);
848 if (inc_recurse && file_total == 1)
849 recv_additional_file_list(f_in);
850 verbose = save_verbose;
853 local_name = get_local_name(flist,argv[0]);
855 /* Now that we know what our destination directory turned out to be,
856 * we can sanitize the --link-/copy-/compare-dest args correctly. */
857 if (sanitize_paths) {
859 for (dir = basis_dir; *dir; dir++) {
860 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
863 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
868 if (server_filter_list.head) {
870 struct filter_list_struct *elp = &server_filter_list;
872 for (dir = basis_dir; *dir; dir++) {
873 if (check_filter(elp, *dir, 1) < 0)
874 goto options_rejected;
876 if (partial_dir && *partial_dir == '/'
877 && check_filter(elp, partial_dir, 1) < 0) {
880 "Your options have been rejected by the server.\n");
881 exit_cleanup(RERR_SYNTAX);
885 exit_code = do_recv(f_in, f_out, local_name);
886 exit_cleanup(exit_code);
890 int child_main(int argc, char *argv[])
892 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
897 void start_server(int f_in, int f_out, int argc, char *argv[])
899 set_nonblocking(f_in);
900 set_nonblocking(f_out);
902 io_set_sock_fds(f_in, f_out);
903 setup_protocol(f_out, f_in);
908 if (protocol_version >= 23)
909 io_start_multiplex_out();
912 keep_dirlinks = 0; /* Must be disabled on the sender. */
913 if (need_messages_from_generator)
914 io_start_multiplex_in();
915 recv_filter_list(f_in);
916 do_server_sender(f_in, f_out, argc, argv);
918 do_server_recv(f_in, f_out, argc, argv);
924 * This is called once the connection has been negotiated. It is used
925 * for rsyncd, remote-shell, and local connections.
927 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
929 struct file_list *flist = NULL;
930 int exit_code = 0, exit_code2 = 0;
931 char *local_name = NULL;
933 cleanup_child_pid = pid;
935 set_nonblocking(f_in);
936 set_nonblocking(f_out);
939 io_set_sock_fds(f_in, f_out);
940 setup_protocol(f_out,f_in);
945 /* We set our stderr file handle to blocking because ssh might have
946 * set it to non-blocking. This can be particularly troublesome if
947 * stderr is a clone of stdout, because ssh would have set our stdout
948 * to non-blocking at the same time (which can easily cause us to lose
949 * output from our print statements). This kluge shouldn't cause ssh
950 * any problems for how we use it. Note also that we delayed setting
951 * this until after the above protocol setup so that we know for sure
952 * that ssh is done twiddling its file descriptors. */
953 set_blocking(STDERR_FILENO);
956 keep_dirlinks = 0; /* Must be disabled on the sender. */
957 if (protocol_version >= 30)
958 io_start_multiplex_out();
960 io_start_buffering_out(f_out);
963 send_filter_list(f_out);
967 if (write_batch && !am_server)
968 start_write_batch(f_out);
969 flist = send_file_list(f_out, argc, argv);
972 rprintf(FINFO,"file list sent\n");
974 if (protocol_version >= 23)
975 io_start_multiplex_in();
977 io_flush(NORMAL_FLUSH);
978 send_files(f_in, f_out);
979 io_flush(FULL_FLUSH);
981 if (protocol_version >= 24)
982 read_final_goodbye(f_in);
985 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
986 io_flush(FULL_FLUSH);
987 wait_process_with_flush(pid, &exit_code);
990 io_flush(FULL_FLUSH);
991 exit_cleanup(exit_code);
995 if (protocol_version >= 23)
996 io_start_multiplex_in();
997 if (need_messages_from_generator)
998 io_start_multiplex_out();
1004 send_filter_list(read_batch ? -1 : f_out);
1006 if (filesfrom_fd >= 0) {
1007 io_set_filesfrom_fds(filesfrom_fd, f_out);
1011 if (write_batch && !am_server)
1012 start_write_batch(f_in);
1013 flist = recv_file_list(f_in);
1014 if (inc_recurse && file_total == 1)
1015 recv_additional_file_list(f_in);
1017 if (flist && flist->used > 0) {
1018 local_name = get_local_name(flist, argv[0]);
1022 exit_code2 = do_recv(f_in, f_out, local_name);
1030 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1031 io_flush(FULL_FLUSH);
1032 wait_process_with_flush(pid, &exit_code);
1035 return MAX(exit_code, exit_code2);
1038 static int copy_argv(char *argv[])
1042 for (i = 0; argv[i]; i++) {
1043 if (!(argv[i] = strdup(argv[i]))) {
1044 rprintf (FERROR, "out of memory at %s(%d)\n",
1045 __FILE__, __LINE__);
1055 * Start a client for either type of remote connection. Work out
1056 * whether the arguments request a remote shell or rsyncd connection,
1057 * and call the appropriate connection function, then run_client.
1059 * Calls either start_socket_client (for sockets) or do_cmd and
1060 * client_run (for ssh).
1062 static int start_client(int argc, char *argv[])
1065 char *shell_machine = NULL;
1066 char *shell_path = NULL;
1067 char *shell_user = NULL;
1073 /* Don't clobber argv[] so that ps(1) can still show the right
1075 if ((rc = copy_argv(argv)))
1078 if (!read_batch) { /* for read_batch, NO source is specified */
1079 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1080 if (shell_path) { /* source is remote */
1084 && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1086 "The source and destination cannot both be remote.\n");
1087 exit_cleanup(RERR_SYNTAX);
1090 if (filesfrom_host && *filesfrom_host
1091 && strcmp(filesfrom_host, shell_machine) != 0) {
1093 "--files-from hostname is not the same as the transfer hostname\n");
1094 exit_cleanup(RERR_SYNTAX);
1098 daemon_over_rsh = shell_cmd ? 1 : -1;
1099 } else { /* source is local, check dest arg */
1109 shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1110 if (shell_path && filesfrom_host && *filesfrom_host
1111 && strcmp(filesfrom_host, shell_machine) != 0) {
1113 "--files-from hostname is not the same as the transfer hostname\n");
1114 exit_cleanup(RERR_SYNTAX);
1116 if (!shell_path) { /* no hostspec found, so src & dest are local */
1118 if (filesfrom_host) {
1120 "--files-from cannot be remote when the transfer is local\n");
1121 exit_cleanup(RERR_SYNTAX);
1123 shell_machine = NULL;
1125 } else if (rsync_port)
1126 daemon_over_rsh = shell_cmd ? 1 : -1;
1128 } else { /* read_batch */
1130 shell_path = argv[argc-1];
1131 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1132 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1133 exit_cleanup(RERR_SYNTAX);
1137 /* for remote source, only single dest arg can remain ... */
1138 if (!am_sender && argc > 1) {
1140 exit_cleanup(RERR_SYNTAX);
1143 if (daemon_over_rsh < 0)
1144 return start_socket_client(shell_machine, shell_path, argc, argv);
1146 if (password_file && !daemon_over_rsh) {
1147 rprintf(FERROR, "The --password-file option may only be "
1148 "used when accessing an rsync daemon.\n");
1149 exit_cleanup(RERR_SYNTAX);
1152 if (shell_machine) {
1153 p = strrchr(shell_machine,'@');
1156 shell_user = shell_machine;
1157 shell_machine = p+1;
1162 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1163 shell_cmd ? shell_cmd : "",
1164 shell_machine ? shell_machine : "",
1165 shell_user ? shell_user : "",
1166 shell_path ? shell_path : "");
1169 /* ... or no dest at all */
1170 if (!am_sender && argc == 0)
1173 pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1176 /* if we're running an rsync server on the remote host over a
1177 * remote shell command, we need to do the RSYNCD protocol first */
1178 if (daemon_over_rsh) {
1180 tmpret = start_inband_exchange(shell_user, shell_path,
1186 ret = client_run(f_in, f_out, pid, argc, argv);
1195 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1197 exit_cleanup(RERR_SIGNAL1);
1200 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1206 _exit(RERR_PARTIAL);
1210 RETSIGTYPE remember_children(UNUSED(int val))
1215 /* An empty waitpid() loop was put here by Tridge and we could never
1216 * get him to explain why he put it in, so rather than taking it
1217 * out we're instead saving the child exit statuses for later use.
1218 * The waitpid() loop presumably eliminates all possibility of leaving
1219 * zombie children, maybe that's why he did it. */
1220 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1221 /* save the child's exit status */
1222 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1223 if (pid_stat_table[cnt].pid == 0) {
1224 pid_stat_table[cnt].pid = pid;
1225 pid_stat_table[cnt].status = status;
1231 #ifndef HAVE_SIGACTION
1232 signal(SIGCHLD, remember_children);
1238 * This routine catches signals and tries to send them to gdb.
1240 * Because it's called from inside a signal handler it ought not to
1241 * use too many library routines.
1243 * @todo Perhaps use "screen -X" instead/as well, to help people
1244 * debugging without easy access to X. Perhaps use an environment
1245 * variable, or just call a script?
1247 * @todo The /proc/ magic probably only works on Linux (and
1248 * Solaris?) Can we be more portable?
1250 #ifdef MAINTAINER_MODE
1251 const char *get_panic_action(void)
1253 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1258 return "xterm -display :0 -T Panic -n Panic "
1259 "-e gdb /proc/%d/exe %d";
1264 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1266 * This signal handler is only installed if we were configured with
1267 * --enable-maintainer-mode. Perhaps it should always be on and we
1268 * should just look at the environment variable, but I'm a bit leery
1269 * of a signal sending us into a busy loop.
1271 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1276 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1277 getpid(), getpid());
1279 /* Unless we failed to execute gdb, we allow the process to
1280 * continue. I'm not sure if that's right. */
1281 ret = system(cmd_buf);
1288 int main(int argc,char *argv[])
1291 int orig_argc = argc;
1292 char **orig_argv = argv;
1293 #ifdef HAVE_SIGACTION
1294 # ifdef HAVE_SIGPROCMASK
1297 sigemptyset(&sigmask);
1299 sigact.sa_flags = SA_NOCLDSTOP;
1301 SIGACTMASK(SIGUSR1, sigusr1_handler);
1302 SIGACTMASK(SIGUSR2, sigusr2_handler);
1303 SIGACTMASK(SIGCHLD, remember_children);
1304 #ifdef MAINTAINER_MODE
1305 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1306 SIGACTMASK(SIGFPE, rsync_panic_handler);
1307 SIGACTMASK(SIGABRT, rsync_panic_handler);
1308 SIGACTMASK(SIGBUS, rsync_panic_handler);
1311 starttime = time(NULL);
1312 am_root = (MY_UID() == 0);
1314 memset(&stats, 0, sizeof(stats));
1318 exit_cleanup(RERR_SYNTAX);
1321 /* we set a 0 umask so that correct file permissions can be
1323 orig_umask = umask(0);
1325 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1326 setlocale(LC_CTYPE, "");
1329 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1330 /* FIXME: We ought to call the same error-handling
1331 * code here, rather than relying on getopt. */
1333 exit_cleanup(RERR_SYNTAX);
1336 SIGACTMASK(SIGINT, sig_int);
1337 SIGACTMASK(SIGHUP, sig_int);
1338 SIGACTMASK(SIGTERM, sig_int);
1339 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1340 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1343 /* Ignore SIGPIPE; we consistently check error codes and will
1345 SIGACTION(SIGPIPE, SIG_IGN);
1347 SIGACTION(SIGXFSZ, SIG_IGN);
1350 /* Initialize push_dir here because on some old systems getcwd
1351 * (implemented by forking "pwd" and reading its output) doesn't
1352 * work when there are other child processes. Also, on all systems
1353 * that implement getcwd that way "pwd" can't be found after chroot. */
1358 if ((write_batch || read_batch) && !am_server) {
1360 write_batch_shell_file(orig_argc, orig_argv, argc);
1362 if (read_batch && strcmp(batch_name, "-") == 0)
1363 batch_fd = STDIN_FILENO;
1365 batch_fd = do_open(batch_name,
1366 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1367 : O_RDONLY, S_IRUSR | S_IWUSR);
1370 rsyserr(FERROR, errno, "Batch file %s open error",
1371 full_fname(batch_name));
1372 exit_cleanup(RERR_FILEIO);
1375 read_stream_flags(batch_fd);
1377 write_stream_flags(batch_fd);
1380 if (write_batch < 0)
1383 if (am_daemon && !am_server)
1384 return daemon_main();
1388 exit_cleanup(RERR_SYNTAX);
1392 set_nonblocking(STDIN_FILENO);
1393 set_nonblocking(STDOUT_FILENO);
1395 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1396 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1399 ret = start_client(argc, argv);
1401 exit_cleanup(RERR_STARTCLIENT);