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 protect_args;
53 extern int relative_paths;
54 extern int sanitize_paths;
55 extern int curr_dir_depth;
56 extern int curr_dir_len;
58 extern int rsync_port;
59 extern int whole_file;
60 extern int read_batch;
61 extern int write_batch;
63 extern int filesfrom_fd;
64 extern pid_t cleanup_child_pid;
65 extern struct stats stats;
66 extern char *filesfrom_host;
67 extern char *partial_dir;
68 extern char *basis_dir[];
69 extern char *rsync_path;
70 extern char *shell_cmd;
71 extern char *batch_name;
72 extern char *password_file;
73 extern char curr_dir[MAXPATHLEN];
74 extern struct file_list *first_flist;
75 extern struct filter_list_struct server_filter_list;
77 extern iconv_t ic_send;
81 int daemon_over_rsh = 0;
82 mode_t orig_umask = 0;
83 int batch_gen_fd = -1;
85 /* There's probably never more than at most 2 outstanding child processes,
86 * but set it higher, just in case. */
87 #define MAXCHILDPROCS 7
90 # ifdef HAVE_SIGPROCMASK
91 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
93 # define SIGACTMASK(n,h) SIGACTION(n,h)
95 static struct sigaction sigact;
101 } pid_stat_table[MAXCHILDPROCS];
103 static time_t starttime, endtime;
104 static int64 total_read, total_written;
106 static void show_malloc_stats(void);
108 /* Works like waitpid(), but if we already harvested the child pid in our
109 * remember_children(), we succeed instead of returning an error. */
110 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
115 waited_pid = waitpid(pid, status_ptr, flags);
116 } while (waited_pid == -1 && errno == EINTR);
118 if (waited_pid == -1 && errno == ECHILD) {
119 /* Status of requested child no longer available: check to
120 * see if it was processed by remember_children(). */
122 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
123 if (pid == pid_stat_table[cnt].pid) {
124 *status_ptr = pid_stat_table[cnt].status;
125 pid_stat_table[cnt].pid = 0;
134 /* Wait for a process to exit, calling io_flush while waiting. */
135 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
140 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
142 io_flush(FULL_FLUSH);
145 /* TODO: If the child exited on a signal, then log an
146 * appropriate error message. Perhaps we should also accept a
147 * message describing the purpose of the child. Also indicate
148 * this to the caller so that they know something went wrong. */
149 if (waited_pid < 0) {
150 rsyserr(FERROR, errno, "waitpid");
151 *exit_code_ptr = RERR_WAITCHILD;
152 } else if (!WIFEXITED(status)) {
154 if (WCOREDUMP(status))
155 *exit_code_ptr = RERR_CRASHED;
158 if (WIFSIGNALED(status))
159 *exit_code_ptr = RERR_TERMINATED;
161 *exit_code_ptr = RERR_WAITCHILD;
163 *exit_code_ptr = WEXITSTATUS(status);
166 /* This function gets called from all 3 processes. We want the client side
167 * to actually output the text, but the sender is the only process that has
168 * all the stats we need. So, if we're a client sender, we do the report.
169 * If we're a server sender, we write the stats on the supplied fd. If
170 * we're the client receiver we read the stats from the supplied fd and do
171 * the report. All processes might also generate a set of debug stats, if
172 * the verbose level is high enough (this is the only thing that the
173 * generator process and the server receiver ever do here). */
174 static void handle_stats(int f)
176 endtime = time(NULL);
178 /* Cache two stats because the read/write code can change it. */
179 total_read = stats.total_read;
180 total_written = stats.total_written;
182 if (do_stats && verbose > 1) {
183 /* These come out from every process */
192 if (f == -1 || !am_sender)
198 write_varlong30(f, total_read, 3);
199 write_varlong30(f, total_written, 3);
200 write_varlong30(f, stats.total_size, 3);
201 if (protocol_version >= 29) {
202 write_varlong30(f, stats.flist_buildtime, 3);
203 write_varlong30(f, stats.flist_xfertime, 3);
209 /* this is the client */
211 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
213 else if (!am_sender) {
214 /* Read the first two in opposite order because the meaning of
215 * read/write swaps when switching from sender to receiver. */
216 total_written = read_varlong30(f, 3);
217 total_read = read_varlong30(f, 3);
218 stats.total_size = read_varlong30(f, 3);
219 if (protocol_version >= 29) {
220 stats.flist_buildtime = read_varlong30(f, 3);
221 stats.flist_xfertime = read_varlong30(f, 3);
223 } else if (write_batch) {
224 /* The --read-batch process is going to be a client
225 * receiver, so we need to give it the stats. */
226 write_varlong30(batch_fd, total_read, 3);
227 write_varlong30(batch_fd, total_written, 3);
228 write_varlong30(batch_fd, stats.total_size, 3);
229 if (protocol_version >= 29) {
230 write_varlong30(batch_fd, stats.flist_buildtime, 3);
231 write_varlong30(batch_fd, stats.flist_xfertime, 3);
236 static void output_summary(void)
239 rprintf(FCLIENT, "\n");
240 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
241 rprintf(FINFO,"Number of files transferred: %d\n",
242 stats.num_transferred_files);
243 rprintf(FINFO,"Total file size: %s bytes\n",
244 human_num(stats.total_size));
245 rprintf(FINFO,"Total transferred file size: %s bytes\n",
246 human_num(stats.total_transferred_size));
247 rprintf(FINFO,"Literal data: %s bytes\n",
248 human_num(stats.literal_data));
249 rprintf(FINFO,"Matched data: %s bytes\n",
250 human_num(stats.matched_data));
251 rprintf(FINFO,"File list size: %s\n",
252 human_num(stats.flist_size));
253 if (stats.flist_buildtime) {
255 "File list generation time: %.3f seconds\n",
256 (double)stats.flist_buildtime / 1000);
258 "File list transfer time: %.3f seconds\n",
259 (double)stats.flist_xfertime / 1000);
261 rprintf(FINFO,"Total bytes sent: %s\n",
262 human_num(total_written));
263 rprintf(FINFO,"Total bytes received: %s\n",
264 human_num(total_read));
267 if (verbose || do_stats) {
268 rprintf(FCLIENT, "\n");
270 "sent %s bytes received %s bytes %s bytes/sec\n",
271 human_num(total_written), human_num(total_read),
272 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
273 rprintf(FINFO, "total size is %s speedup is %.2f\n",
274 human_num(stats.total_size),
275 (double)stats.total_size / (total_written+total_read));
284 * If our C library can get malloc statistics, then show them to FINFO
286 static void show_malloc_stats(void)
293 rprintf(FCLIENT, "\n");
294 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
295 getpid(), am_server ? "server " : "",
296 am_daemon ? "daemon " : "", who_am_i());
297 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
299 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
301 rprintf(FINFO, " smblks: %10ld\n",
303 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
305 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
307 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
308 (long)mi.arena + mi.hblkhd);
309 rprintf(FINFO, " usmblks: %10ld\n",
311 rprintf(FINFO, " fsmblks: %10ld\n",
313 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
315 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
317 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
319 #endif /* HAVE_MALLINFO */
323 /* Start the remote shell. cmd may be NULL to use the default. */
324 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
325 int *f_in_p, int *f_out_p)
328 char *args[MAX_ARGS];
333 if (!read_batch && !local_server) {
334 char *t, *f, in_quote = '\0';
335 char *rsh_env = getenv(RSYNC_RSH_ENV);
344 for (t = f = cmd; *f; f++) {
347 /* Comparison leaves rooms for server_options(). */
348 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
351 while (*f != ' ' || in_quote) {
355 "Missing trailing-%c in remote-shell command.\n",
357 exit_cleanup(RERR_SYNTAX);
362 if (*f == '\'' || *f == '"') {
367 if (*f == in_quote && *++f != in_quote) {
377 /* check to see if we've already been given '-l user' in
378 * the remote-shell command */
379 for (i = 0; i < argc-1; i++) {
380 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
385 /* remsh (on HPUX) takes the arguments the other way around */
386 args[argc++] = machine;
387 if (user && !(daemon_over_rsh && dash_l_set)) {
392 if (user && !(daemon_over_rsh && dash_l_set)) {
396 args[argc++] = machine;
399 args[argc++] = rsync_path;
401 if (blocking_io < 0) {
403 if ((cp = strrchr(cmd, '/')) != NULL)
407 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
411 server_options(args,&argc);
413 if (argc >= MAX_ARGS - 2)
419 if (!daemon_over_rsh) {
420 while (remote_argc > 0) {
421 if (argc >= MAX_ARGS - 1) {
423 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
424 exit_cleanup(RERR_SYNTAX);
426 args[argc++] = *remote_argv++;
434 for (i = 0; i < argc; i++)
435 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
436 rprintf(FCLIENT, "\n");
440 int from_gen_pipe[2];
441 if (fd_pair(from_gen_pipe) < 0) {
442 rsyserr(FERROR, errno, "pipe");
443 exit_cleanup(RERR_IPC);
445 batch_gen_fd = from_gen_pipe[0];
446 *f_out_p = from_gen_pipe[1];
448 ret = -1; /* no child pid */
449 } else if (local_server) {
450 /* If the user didn't request --[no-]whole-file, force
451 * it on, but only if we're not batch processing. */
452 if (whole_file < 0 && !write_batch)
454 ret = local_child(argc, args, f_in_p, f_out_p, child_main);
459 int convert = ic_send != (iconv_t)-1;
463 alloc_xbuf(&outbuf, 1024);
466 ret = piped_child(args, f_in_p, f_out_p);
468 for (i = 0; args[i]; i++) {} /* find first NULL */
469 args[i] = "rsync"; /* set a new arg0 */
471 print_child_argv("protected args:", args + i + 1);
476 INIT_XBUF_STRLEN(inbuf, args[i]);
477 iconvbufs(ic_send, &inbuf, &outbuf,
478 ICB_EXPAND_OUT | ICB_INCLUDE_BAD | ICB_INCLUDE_INCOMPLETE);
479 outbuf.buf[outbuf.len] = '\0';
480 write_buf(fd, outbuf.buf, outbuf.len + 1);
484 write_buf(fd, args[i], strlen(args[i]) + 1);
492 ret = piped_child(args, f_in_p, f_out_p);
501 out_of_memory("do_cmd");
502 return 0; /* not reached */
505 /* The receiving side operates in one of two modes:
507 * 1. it receives any number of files into a destination directory,
508 * placing them according to their names in the file-list.
510 * 2. it receives a single file and saves it using the name in the
511 * destination path instead of its file-list name. This requires a
512 * "local name" for writing out the destination file.
514 * So, our task is to figure out what mode/local-name we need.
515 * For mode 1, we change into the destination directory and return NULL.
516 * For mode 2, we change into the directory containing the destination
517 * file (if we aren't already there) and return the local-name. */
518 static char *get_local_name(struct file_list *flist, char *dest_path)
525 rprintf(FINFO, "get_local_name count=%d %s\n",
526 file_total, NS(dest_path));
529 if (!dest_path || list_only)
532 /* See what currently exists at the destination. */
533 if ((statret = do_stat(dest_path, &st)) == 0) {
534 /* If the destination is a dir, enter it and use mode 1. */
535 if (S_ISDIR(st.st_mode)) {
536 if (!push_dir(dest_path, 0)) {
537 rsyserr(FERROR, errno, "push_dir#1 %s failed",
538 full_fname(dest_path));
539 exit_cleanup(RERR_FILESELECT);
543 if (file_total > 1) {
545 "ERROR: destination must be a directory when"
546 " copying more than 1 file\n");
547 exit_cleanup(RERR_FILESELECT);
549 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
551 "ERROR: cannot overwrite non-directory"
552 " with a directory\n");
553 exit_cleanup(RERR_FILESELECT);
555 } else if (errno != ENOENT) {
556 /* If we don't know what's at the destination, fail. */
557 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
558 full_fname(dest_path));
559 exit_cleanup(RERR_FILESELECT);
562 cp = strrchr(dest_path, '/');
564 /* If we need a destination directory because the transfer is not
565 * of a single non-directory or the user has requested one via a
566 * destination path ending in a slash, create one and use mode 1. */
567 if (file_total > 1 || (cp && !cp[1])) {
568 /* Lop off the final slash (if any). */
574 "ERROR: destination path is not a directory\n");
575 exit_cleanup(RERR_SYNTAX);
578 if (mkdir_defmode(dest_path) != 0) {
579 rsyserr(FERROR, errno, "mkdir %s failed",
580 full_fname(dest_path));
581 exit_cleanup(RERR_FILEIO);
584 if (strcmp(flist->files[0]->basename, ".") == 0)
585 flist->files[0]->flags |= FLAG_DIR_CREATED;
588 rprintf(FINFO, "created directory %s\n", dest_path);
591 /* Indicate that dest dir doesn't really exist. */
595 if (!push_dir(dest_path, dry_run > 1)) {
596 rsyserr(FERROR, errno, "push_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 (!push_dir(dest_path, 0)) {
616 rsyserr(FERROR, errno, "push_dir#3 %s failed",
617 full_fname(dest_path));
618 exit_cleanup(RERR_FILESELECT);
625 /* Call this if the destination dir (which is assumed to be in curr_dir)
626 * does not yet exist and we can't create it due to being in dry-run
627 * mode. We'll fix dirs that can be relative to the non-existent dir. */
628 static void fix_basis_dirs(void)
630 char **dir, *new, *slash;
636 slash = strrchr(curr_dir, '/');
638 for (dir = basis_dir; *dir; dir++) {
641 len = curr_dir_len + 1 + strlen(*dir) + 1;
642 if (!(new = new_array(char, len)))
643 out_of_memory("fix_basis_dirs");
644 if (slash && strncmp(*dir, "../", 3) == 0) {
645 /* We want to remove only one leading "../" prefix for
646 * the directory we couldn't create in dry-run mode:
647 * this ensures that any other ".." references get
648 * evaluated the same as they would for a live copy. */
650 pathjoin(new, len, curr_dir, *dir + 3);
653 pathjoin(new, len, curr_dir, *dir);
658 /* This is only called by the sender. */
659 static void read_final_goodbye(int f_in)
663 char xname[MAXPATHLEN];
665 if (protocol_version < 29)
668 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
673 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
675 exit_cleanup(RERR_PROTOCOL);
679 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
681 struct file_list *flist;
685 rprintf(FINFO, "server_sender starting pid=%ld\n",
689 if (am_daemon && lp_write_only(module_id)) {
690 rprintf(FERROR, "ERROR: module is write only\n");
691 exit_cleanup(RERR_SYNTAX);
694 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
696 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
697 remove_source_files == 1 ? "source" : "sent");
698 exit_cleanup(RERR_SYNTAX);
702 if (!relative_paths) {
703 if (!push_dir(dir, 0)) {
704 rsyserr(FERROR, errno, "push_dir#3 %s failed",
706 exit_cleanup(RERR_FILESELECT);
712 if (argc == 0 && (recurse || list_only)) {
718 flist = send_file_list(f_out,argc,argv);
719 if (!flist || flist->used == 0)
722 io_start_buffering_in(f_in);
724 send_files(f_in, f_out);
725 io_flush(FULL_FLUSH);
727 if (protocol_version >= 24)
728 read_final_goodbye(f_in);
729 io_flush(FULL_FLUSH);
734 static int do_recv(int f_in, int f_out, char *local_name)
740 /* The receiving side mustn't obey this, or an existing symlink that
741 * points to an identical file won't be replaced by the referent. */
742 copy_links = copy_dirlinks = 0;
744 #ifdef SUPPORT_HARD_LINKS
745 if (preserve_hard_links && !inc_recurse)
746 match_hard_links(first_flist);
749 if (fd_pair(error_pipe) < 0) {
750 rsyserr(FERROR, errno, "pipe failed in do_recv");
751 exit_cleanup(RERR_IPC);
754 io_flush(NORMAL_FLUSH);
756 if ((pid = do_fork()) == -1) {
757 rsyserr(FERROR, errno, "fork failed in do_recv");
758 exit_cleanup(RERR_IPC);
762 close(error_pipe[0]);
766 /* we can't let two processes write to the socket at one time */
767 io_end_multiplex_out();
769 /* set place to send errors */
770 set_msg_fd_out(error_pipe[1]);
771 io_start_buffering_out(error_pipe[1]);
773 recv_files(f_in, local_name);
774 io_flush(FULL_FLUSH);
777 send_msg(MSG_DONE, "", 1, 0);
778 write_varlong(error_pipe[1], stats.total_read, 3);
779 io_flush(FULL_FLUSH);
781 /* Handle any keep-alive packets from the post-processing work
782 * that the generator does. */
783 if (protocol_version >= 29) {
786 char xname[MAXPATHLEN];
788 kluge_around_eof = -1;
790 /* This should only get stopped via a USR2 signal. */
791 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
794 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
796 exit_cleanup(RERR_PROTOCOL);
799 /* Finally, we go to sleep until our parent kills us with a
800 * USR2 signal. We sleep for a short time, as on some OSes
801 * a signal won't interrupt a sleep! */
808 io_end_multiplex_in();
809 if (write_batch && !am_server)
812 close(error_pipe[1]);
816 io_start_buffering_out(f_out);
818 set_msg_fd_in(error_pipe[0]);
819 io_start_buffering_in(error_pipe[0]);
821 #ifdef SUPPORT_HARD_LINKS
822 if (preserve_hard_links && inc_recurse) {
823 struct file_list *flist;
824 for (flist = first_flist; flist; flist = flist->next)
825 match_hard_links(flist);
829 generate_files(f_out, local_name);
832 io_flush(FULL_FLUSH);
833 if (protocol_version >= 24) {
834 /* send a final goodbye message */
835 write_ndx(f_out, NDX_DONE);
837 io_flush(FULL_FLUSH);
841 wait_process_with_flush(pid, &exit_code);
845 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
848 struct file_list *flist;
849 char *local_name = NULL;
851 int save_verbose = verbose;
853 if (filesfrom_fd >= 0) {
854 /* We can't mix messages with files-from data on the socket,
855 * so temporarily turn off verbose messages. */
860 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
861 argc, (long)getpid());
864 if (am_daemon && lp_read_only(module_id)) {
865 rprintf(FERROR,"ERROR: module is read only\n");
866 exit_cleanup(RERR_SYNTAX);
874 if (!am_daemon && !push_dir(dir, 0)) {
875 rsyserr(FERROR, errno, "push_dir#4 %s failed",
877 exit_cleanup(RERR_FILESELECT);
881 if (protocol_version >= 30)
882 io_start_multiplex_in();
884 io_start_buffering_in(f_in);
885 recv_filter_list(f_in);
887 if (filesfrom_fd >= 0) {
888 /* We need to send the files-from names to the sender at the
889 * same time that we receive the file-list from them, so we
890 * need the IO routines to automatically write out the names
891 * onto our f_out socket as we read the file-list. This
892 * avoids both deadlock and extra delays/buffers. */
893 io_set_filesfrom_fds(filesfrom_fd, f_out);
897 flist = recv_file_list(f_in);
899 rprintf(FERROR,"server_recv: recv_file_list error\n");
900 exit_cleanup(RERR_FILESELECT);
902 if (inc_recurse && file_total == 1)
903 recv_additional_file_list(f_in);
904 verbose = save_verbose;
907 local_name = get_local_name(flist,argv[0]);
909 /* Now that we know what our destination directory turned out to be,
910 * we can sanitize the --link-/copy-/compare-dest args correctly. */
911 if (sanitize_paths) {
913 for (dir = basis_dir; *dir; dir++) {
914 *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
917 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
922 if (server_filter_list.head) {
924 struct filter_list_struct *elp = &server_filter_list;
926 for (dir = basis_dir; *dir; dir++) {
927 if (check_filter(elp, *dir, 1) < 0)
928 goto options_rejected;
930 if (partial_dir && *partial_dir == '/'
931 && check_filter(elp, partial_dir, 1) < 0) {
934 "Your options have been rejected by the server.\n");
935 exit_cleanup(RERR_SYNTAX);
939 exit_code = do_recv(f_in, f_out, local_name);
940 exit_cleanup(exit_code);
944 int child_main(int argc, char *argv[])
946 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
951 void start_server(int f_in, int f_out, int argc, char *argv[])
953 set_nonblocking(f_in);
954 set_nonblocking(f_out);
956 io_set_sock_fds(f_in, f_out);
957 setup_protocol(f_out, f_in);
959 if (protocol_version >= 23)
960 io_start_multiplex_out();
963 keep_dirlinks = 0; /* Must be disabled on the sender. */
964 if (need_messages_from_generator)
965 io_start_multiplex_in();
966 recv_filter_list(f_in);
967 do_server_sender(f_in, f_out, argc, argv);
969 do_server_recv(f_in, f_out, argc, argv);
975 * This is called once the connection has been negotiated. It is used
976 * for rsyncd, remote-shell, and local connections.
978 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
980 struct file_list *flist = NULL;
981 int exit_code = 0, exit_code2 = 0;
982 char *local_name = NULL;
984 cleanup_child_pid = pid;
986 set_nonblocking(f_in);
987 set_nonblocking(f_out);
990 io_set_sock_fds(f_in, f_out);
991 setup_protocol(f_out,f_in);
993 /* We set our stderr file handle to blocking because ssh might have
994 * set it to non-blocking. This can be particularly troublesome if
995 * stderr is a clone of stdout, because ssh would have set our stdout
996 * to non-blocking at the same time (which can easily cause us to lose
997 * output from our print statements). This kluge shouldn't cause ssh
998 * any problems for how we use it. Note also that we delayed setting
999 * this until after the above protocol setup so that we know for sure
1000 * that ssh is done twiddling its file descriptors. */
1001 set_blocking(STDERR_FILENO);
1004 keep_dirlinks = 0; /* Must be disabled on the sender. */
1005 if (protocol_version >= 30)
1006 io_start_multiplex_out();
1008 io_start_buffering_out(f_out);
1009 if (!filesfrom_host)
1010 set_msg_fd_in(f_in);
1011 send_filter_list(f_out);
1013 filesfrom_fd = f_in;
1015 if (write_batch && !am_server)
1016 start_write_batch(f_out);
1017 flist = send_file_list(f_out, argc, argv);
1020 rprintf(FINFO,"file list sent\n");
1022 if (protocol_version >= 23)
1023 io_start_multiplex_in();
1025 io_flush(NORMAL_FLUSH);
1026 send_files(f_in, f_out);
1027 io_flush(FULL_FLUSH);
1029 if (protocol_version >= 24)
1030 read_final_goodbye(f_in);
1033 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1034 io_flush(FULL_FLUSH);
1035 wait_process_with_flush(pid, &exit_code);
1038 io_flush(FULL_FLUSH);
1039 exit_cleanup(exit_code);
1043 if (protocol_version >= 23)
1044 io_start_multiplex_in();
1045 if (need_messages_from_generator)
1046 io_start_multiplex_out();
1052 send_filter_list(read_batch ? -1 : f_out);
1054 if (filesfrom_fd >= 0) {
1055 io_set_filesfrom_fds(filesfrom_fd, f_out);
1059 if (write_batch && !am_server)
1060 start_write_batch(f_in);
1061 flist = recv_file_list(f_in);
1062 if (inc_recurse && file_total == 1)
1063 recv_additional_file_list(f_in);
1065 if (flist && flist->used > 0) {
1066 local_name = get_local_name(flist, argv[0]);
1070 exit_code2 = do_recv(f_in, f_out, local_name);
1078 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1079 io_flush(FULL_FLUSH);
1080 wait_process_with_flush(pid, &exit_code);
1083 return MAX(exit_code, exit_code2);
1086 static int copy_argv(char *argv[])
1090 for (i = 0; argv[i]; i++) {
1091 if (!(argv[i] = strdup(argv[i]))) {
1092 rprintf (FERROR, "out of memory at %s(%d)\n",
1093 __FILE__, __LINE__);
1103 * Start a client for either type of remote connection. Work out
1104 * whether the arguments request a remote shell or rsyncd connection,
1105 * and call the appropriate connection function, then run_client.
1107 * Calls either start_socket_client (for sockets) or do_cmd and
1108 * client_run (for ssh).
1110 static int start_client(int argc, char *argv[])
1112 char *p, *shell_machine = NULL, *shell_user = NULL;
1119 /* Don't clobber argv[] so that ps(1) can still show the right
1121 if ((ret = copy_argv(argv)) != 0)
1124 if (!read_batch) { /* for read_batch, NO source is specified */
1125 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1126 if (path) { /* source is remote */
1133 if (argc == 1 || **argv == ':')
1134 argc = 0; /* no dest arg */
1135 else if (check_for_hostspec(*argv, &dummy1, &dummy2)) {
1137 "The source and destination cannot both be remote.\n");
1138 exit_cleanup(RERR_SYNTAX);
1140 remote_argc--; /* don't count dest */
1143 if (filesfrom_host && *filesfrom_host
1144 && strcmp(filesfrom_host, shell_machine) != 0) {
1146 "--files-from hostname is not the same as the transfer hostname\n");
1147 exit_cleanup(RERR_SYNTAX);
1151 daemon_over_rsh = shell_cmd ? 1 : -1;
1152 } else { /* source is local, check dest arg */
1157 remote_argv = argv + argc;
1159 static char *dotarg[1] = { "." };
1161 remote_argv = dotarg;
1166 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1167 if (path && filesfrom_host && *filesfrom_host
1168 && strcmp(filesfrom_host, shell_machine) != 0) {
1170 "--files-from hostname is not the same as the transfer hostname\n");
1171 exit_cleanup(RERR_SYNTAX);
1173 if (!path) { /* no hostspec found, so src & dest are local */
1175 if (filesfrom_host) {
1177 "--files-from cannot be remote when the transfer is local\n");
1178 exit_cleanup(RERR_SYNTAX);
1180 shell_machine = NULL;
1181 } else { /* hostspec was found, so dest is remote */
1184 daemon_over_rsh = shell_cmd ? 1 : -1;
1187 } else { /* read_batch */
1189 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1190 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1191 exit_cleanup(RERR_SYNTAX);
1193 remote_argv = argv + argc - 1;
1201 /* For local source, extra source args must not have hostspec. */
1202 for (i = 1; i < argc; i++) {
1203 if (check_for_hostspec(argv[i], &dummy1, &dummy2)) {
1204 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1205 exit_cleanup(RERR_SYNTAX);
1210 /* For remote source, any extra source args must be ":SOURCE" args. */
1211 for (i = 1; i < remote_argc; i++) {
1212 if (*remote_argv[i] != ':') {
1213 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1214 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1215 exit_cleanup(RERR_SYNTAX);
1223 if (daemon_over_rsh < 0)
1224 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1226 if (password_file && !daemon_over_rsh) {
1227 rprintf(FERROR, "The --password-file option may only be "
1228 "used when accessing an rsync daemon.\n");
1229 exit_cleanup(RERR_SYNTAX);
1232 if (shell_machine) {
1233 p = strrchr(shell_machine,'@');
1236 shell_user = shell_machine;
1237 shell_machine = p+1;
1242 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1243 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1244 remote_argv ? NS(remote_argv[0]) : "");
1247 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1250 /* if we're running an rsync server on the remote host over a
1251 * remote shell command, we need to do the RSYNCD protocol first */
1252 if (daemon_over_rsh) {
1254 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1259 ret = client_run(f_in, f_out, pid, argc, argv);
1268 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1270 exit_cleanup(RERR_SIGNAL1);
1273 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1279 _exit(RERR_PARTIAL);
1283 RETSIGTYPE remember_children(UNUSED(int val))
1288 /* An empty waitpid() loop was put here by Tridge and we could never
1289 * get him to explain why he put it in, so rather than taking it
1290 * out we're instead saving the child exit statuses for later use.
1291 * The waitpid() loop presumably eliminates all possibility of leaving
1292 * zombie children, maybe that's why he did it. */
1293 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1294 /* save the child's exit status */
1295 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1296 if (pid_stat_table[cnt].pid == 0) {
1297 pid_stat_table[cnt].pid = pid;
1298 pid_stat_table[cnt].status = status;
1304 #ifndef HAVE_SIGACTION
1305 signal(SIGCHLD, remember_children);
1311 * This routine catches signals and tries to send them to gdb.
1313 * Because it's called from inside a signal handler it ought not to
1314 * use too many library routines.
1316 * @todo Perhaps use "screen -X" instead/as well, to help people
1317 * debugging without easy access to X. Perhaps use an environment
1318 * variable, or just call a script?
1320 * @todo The /proc/ magic probably only works on Linux (and
1321 * Solaris?) Can we be more portable?
1323 #ifdef MAINTAINER_MODE
1324 const char *get_panic_action(void)
1326 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1331 return "xterm -display :0 -T Panic -n Panic "
1332 "-e gdb /proc/%d/exe %d";
1337 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1339 * This signal handler is only installed if we were configured with
1340 * --enable-maintainer-mode. Perhaps it should always be on and we
1341 * should just look at the environment variable, but I'm a bit leery
1342 * of a signal sending us into a busy loop.
1344 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1349 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1350 getpid(), getpid());
1352 /* Unless we failed to execute gdb, we allow the process to
1353 * continue. I'm not sure if that's right. */
1354 ret = system(cmd_buf);
1361 int main(int argc,char *argv[])
1364 int orig_argc = argc;
1365 char **orig_argv = argv;
1366 #ifdef HAVE_SIGACTION
1367 # ifdef HAVE_SIGPROCMASK
1370 sigemptyset(&sigmask);
1372 sigact.sa_flags = SA_NOCLDSTOP;
1374 SIGACTMASK(SIGUSR1, sigusr1_handler);
1375 SIGACTMASK(SIGUSR2, sigusr2_handler);
1376 SIGACTMASK(SIGCHLD, remember_children);
1377 #ifdef MAINTAINER_MODE
1378 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1379 SIGACTMASK(SIGFPE, rsync_panic_handler);
1380 SIGACTMASK(SIGABRT, rsync_panic_handler);
1381 SIGACTMASK(SIGBUS, rsync_panic_handler);
1384 starttime = time(NULL);
1385 am_root = (MY_UID() == 0);
1387 memset(&stats, 0, sizeof(stats));
1391 exit_cleanup(RERR_SYNTAX);
1394 /* we set a 0 umask so that correct file permissions can be
1396 orig_umask = umask(0);
1398 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1399 setlocale(LC_CTYPE, "");
1402 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1403 /* FIXME: We ought to call the same error-handling
1404 * code here, rather than relying on getopt. */
1406 exit_cleanup(RERR_SYNTAX);
1409 SIGACTMASK(SIGINT, sig_int);
1410 SIGACTMASK(SIGHUP, sig_int);
1411 SIGACTMASK(SIGTERM, sig_int);
1412 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1413 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1416 /* Ignore SIGPIPE; we consistently check error codes and will
1418 SIGACTION(SIGPIPE, SIG_IGN);
1420 SIGACTION(SIGXFSZ, SIG_IGN);
1423 /* Initialize push_dir here because on some old systems getcwd
1424 * (implemented by forking "pwd" and reading its output) doesn't
1425 * work when there are other child processes. Also, on all systems
1426 * that implement getcwd that way "pwd" can't be found after chroot. */
1431 if ((write_batch || read_batch) && !am_server) {
1433 write_batch_shell_file(orig_argc, orig_argv, argc);
1435 if (read_batch && strcmp(batch_name, "-") == 0)
1436 batch_fd = STDIN_FILENO;
1438 batch_fd = do_open(batch_name,
1439 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1440 : O_RDONLY, S_IRUSR | S_IWUSR);
1443 rsyserr(FERROR, errno, "Batch file %s open error",
1444 full_fname(batch_name));
1445 exit_cleanup(RERR_FILEIO);
1448 read_stream_flags(batch_fd);
1450 write_stream_flags(batch_fd);
1453 if (write_batch < 0)
1456 if (am_daemon && !am_server)
1457 return daemon_main();
1459 if (am_server && protect_args) {
1460 char buf[MAXPATHLEN];
1462 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1463 if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1465 exit_cleanup(RERR_SYNTAX);
1471 exit_cleanup(RERR_SYNTAX);
1475 set_nonblocking(STDIN_FILENO);
1476 set_nonblocking(STDOUT_FILENO);
1478 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1479 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1482 ret = start_client(argc, argv);
1484 exit_cleanup(RERR_STARTCLIENT);