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-2009 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, visit the http://fsf.org website.
26 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
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 got_xfer_error;
45 extern int copy_links;
46 extern int copy_dirlinks;
47 extern int copy_unsafe_links;
48 extern int keep_dirlinks;
49 extern int preserve_hard_links;
50 extern int protocol_version;
51 extern int file_total;
54 extern int protect_args;
55 extern int relative_paths;
56 extern int sanitize_paths;
57 extern int curr_dir_depth;
58 extern int curr_dir_len;
60 extern int rsync_port;
61 extern int whole_file;
62 extern int read_batch;
63 extern int write_batch;
65 extern int filesfrom_fd;
66 extern int connect_timeout;
67 extern pid_t cleanup_child_pid;
68 extern unsigned int module_dirlen;
69 extern struct stats stats;
70 extern char *filesfrom_host;
71 extern char *partial_dir;
72 extern char *dest_option;
73 extern char *basis_dir[];
74 extern char *rsync_path;
75 extern char *shell_cmd;
76 extern char *batch_name;
77 extern char *password_file;
78 extern char curr_dir[MAXPATHLEN];
79 extern struct file_list *first_flist;
80 extern struct filter_list_struct daemon_filter_list;
83 int am_receiver = 0; /* Only set to 1 after the receiver/generator fork. */
84 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
86 int daemon_over_rsh = 0;
87 mode_t orig_umask = 0;
88 int batch_gen_fd = -1;
90 /* There's probably never more than at most 2 outstanding child processes,
91 * but set it higher, just in case. */
92 #define MAXCHILDPROCS 7
95 # ifdef HAVE_SIGPROCMASK
96 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
98 # define SIGACTMASK(n,h) SIGACTION(n,h)
100 static struct sigaction sigact;
106 } pid_stat_table[MAXCHILDPROCS];
108 static time_t starttime, endtime;
109 static int64 total_read, total_written;
111 static void show_malloc_stats(void);
113 /* Works like waitpid(), but if we already harvested the child pid in our
114 * remember_children(), we succeed instead of returning an error. */
115 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
120 waited_pid = waitpid(pid, status_ptr, flags);
121 } while (waited_pid == -1 && errno == EINTR);
123 if (waited_pid == -1 && errno == ECHILD) {
124 /* Status of requested child no longer available: check to
125 * see if it was processed by remember_children(). */
127 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
128 if (pid == pid_stat_table[cnt].pid) {
129 *status_ptr = pid_stat_table[cnt].status;
130 pid_stat_table[cnt].pid = 0;
139 /* Wait for a process to exit, calling io_flush while waiting. */
140 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
145 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
147 io_flush(FULL_FLUSH);
150 /* TODO: If the child exited on a signal, then log an
151 * appropriate error message. Perhaps we should also accept a
152 * message describing the purpose of the child. Also indicate
153 * this to the caller so that they know something went wrong. */
154 if (waited_pid < 0) {
155 rsyserr(FERROR, errno, "waitpid");
156 *exit_code_ptr = RERR_WAITCHILD;
157 } else if (!WIFEXITED(status)) {
159 if (WCOREDUMP(status))
160 *exit_code_ptr = RERR_CRASHED;
163 if (WIFSIGNALED(status))
164 *exit_code_ptr = RERR_TERMINATED;
166 *exit_code_ptr = RERR_WAITCHILD;
168 *exit_code_ptr = WEXITSTATUS(status);
171 /* This function gets called from all 3 processes. We want the client side
172 * to actually output the text, but the sender is the only process that has
173 * all the stats we need. So, if we're a client sender, we do the report.
174 * If we're a server sender, we write the stats on the supplied fd. If
175 * we're the client receiver we read the stats from the supplied fd and do
176 * the report. All processes might also generate a set of debug stats, if
177 * the verbose level is high enough (this is the only thing that the
178 * generator process and the server receiver ever do here). */
179 static void handle_stats(int f)
181 endtime = time(NULL);
183 /* Cache two stats because the read/write code can change it. */
184 total_read = stats.total_read;
185 total_written = stats.total_written;
187 if (do_stats && verbose > 1) {
188 /* These come out from every process */
197 if (f == -1 || !am_sender)
203 write_varlong30(f, total_read, 3);
204 write_varlong30(f, total_written, 3);
205 write_varlong30(f, stats.total_size, 3);
206 if (protocol_version >= 29) {
207 write_varlong30(f, stats.flist_buildtime, 3);
208 write_varlong30(f, stats.flist_xfertime, 3);
214 /* this is the client */
216 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
218 else if (!am_sender) {
219 /* Read the first two in opposite order because the meaning of
220 * read/write swaps when switching from sender to receiver. */
221 total_written = read_varlong30(f, 3);
222 total_read = read_varlong30(f, 3);
223 stats.total_size = read_varlong30(f, 3);
224 if (protocol_version >= 29) {
225 stats.flist_buildtime = read_varlong30(f, 3);
226 stats.flist_xfertime = read_varlong30(f, 3);
228 } else if (write_batch) {
229 /* The --read-batch process is going to be a client
230 * receiver, so we need to give it the stats. */
231 write_varlong30(batch_fd, total_read, 3);
232 write_varlong30(batch_fd, total_written, 3);
233 write_varlong30(batch_fd, stats.total_size, 3);
234 if (protocol_version >= 29) {
235 write_varlong30(batch_fd, stats.flist_buildtime, 3);
236 write_varlong30(batch_fd, stats.flist_xfertime, 3);
241 static void output_summary(void)
244 rprintf(FCLIENT, "\n");
245 rprintf(FINFO,"Number of files: %d\n", stats.num_files);
246 rprintf(FINFO,"Number of files transferred: %d\n",
247 stats.num_transferred_files);
248 rprintf(FINFO,"Total file size: %s bytes\n",
249 human_num(stats.total_size));
250 rprintf(FINFO,"Total transferred file size: %s bytes\n",
251 human_num(stats.total_transferred_size));
252 rprintf(FINFO,"Literal data: %s bytes\n",
253 human_num(stats.literal_data));
254 rprintf(FINFO,"Matched data: %s bytes\n",
255 human_num(stats.matched_data));
256 rprintf(FINFO,"File list size: %s\n",
257 human_num(stats.flist_size));
258 if (stats.flist_buildtime) {
260 "File list generation time: %.3f seconds\n",
261 (double)stats.flist_buildtime / 1000);
263 "File list transfer time: %.3f seconds\n",
264 (double)stats.flist_xfertime / 1000);
266 rprintf(FINFO,"Total bytes sent: %s\n",
267 human_num(total_written));
268 rprintf(FINFO,"Total bytes received: %s\n",
269 human_num(total_read));
272 if (verbose || do_stats) {
273 rprintf(FCLIENT, "\n");
275 "sent %s bytes received %s bytes %s bytes/sec\n",
276 human_num(total_written), human_num(total_read),
277 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
278 rprintf(FINFO, "total size is %s speedup is %.2f%s\n",
279 human_num(stats.total_size),
280 (double)stats.total_size / (total_written+total_read),
281 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
290 * If our C library can get malloc statistics, then show them to FINFO
292 static void show_malloc_stats(void)
299 rprintf(FCLIENT, "\n");
300 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
301 getpid(), am_server ? "server " : "",
302 am_daemon ? "daemon " : "", who_am_i());
303 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
305 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
307 rprintf(FINFO, " smblks: %10ld\n",
309 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
311 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
313 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
314 (long)mi.arena + mi.hblkhd);
315 rprintf(FINFO, " usmblks: %10ld\n",
317 rprintf(FINFO, " fsmblks: %10ld\n",
319 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
321 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
323 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
325 #endif /* HAVE_MALLINFO */
329 /* Start the remote shell. cmd may be NULL to use the default. */
330 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
331 int *f_in_p, int *f_out_p)
334 char *args[MAX_ARGS];
338 if (!read_batch && !local_server) {
339 char *t, *f, in_quote = '\0';
340 char *rsh_env = getenv(RSYNC_RSH_ENV);
345 cmd = strdup(cmd); /* MEMORY LEAK */
349 for (t = f = cmd; *f; f++) {
352 /* Comparison leaves rooms for server_options(). */
353 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
356 while (*f != ' ' || in_quote) {
360 "Missing trailing-%c in remote-shell command.\n",
362 exit_cleanup(RERR_SYNTAX);
367 if (*f == '\'' || *f == '"') {
372 if (*f == in_quote && *++f != in_quote) {
382 /* check to see if we've already been given '-l user' in
383 * the remote-shell command */
384 for (i = 0; i < argc-1; i++) {
385 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
390 /* remsh (on HPUX) takes the arguments the other way around */
391 args[argc++] = machine;
392 if (user && !(daemon_over_rsh && dash_l_set)) {
397 if (user && !(daemon_over_rsh && dash_l_set)) {
401 args[argc++] = machine;
404 args[argc++] = rsync_path;
406 if (blocking_io < 0) {
408 if ((cp = strrchr(cmd, '/')) != NULL)
412 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
416 server_options(args,&argc);
418 if (argc >= MAX_ARGS - 2)
424 if (!daemon_over_rsh) {
425 while (remote_argc > 0) {
426 if (argc >= MAX_ARGS - 1) {
428 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
429 exit_cleanup(RERR_SYNTAX);
431 args[argc++] = *remote_argv++;
439 for (i = 0; i < argc; i++)
440 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
441 rprintf(FCLIENT, "\n");
445 int from_gen_pipe[2];
446 set_allow_inc_recurse();
447 if (fd_pair(from_gen_pipe) < 0) {
448 rsyserr(FERROR, errno, "pipe");
449 exit_cleanup(RERR_IPC);
451 batch_gen_fd = from_gen_pipe[0];
452 *f_out_p = from_gen_pipe[1];
454 pid = (pid_t)-1; /* no child pid */
458 } else if (local_server) {
459 /* If the user didn't request --[no-]whole-file, force
460 * it on, but only if we're not batch processing. */
461 if (whole_file < 0 && !write_batch)
463 set_allow_inc_recurse();
464 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
469 pid = piped_child(args, f_in_p, f_out_p);
473 if (protect_args && !daemon_over_rsh)
474 send_protected_args(*f_out_p, args);
480 out_of_memory("do_cmd");
481 return 0; /* not reached */
484 /* The receiving side operates in one of two modes:
486 * 1. it receives any number of files into a destination directory,
487 * placing them according to their names in the file-list.
489 * 2. it receives a single file and saves it using the name in the
490 * destination path instead of its file-list name. This requires a
491 * "local name" for writing out the destination file.
493 * So, our task is to figure out what mode/local-name we need.
494 * For mode 1, we change into the destination directory and return NULL.
495 * For mode 2, we change into the directory containing the destination
496 * file (if we aren't already there) and return the local-name. */
497 static char *get_local_name(struct file_list *flist, char *dest_path)
504 rprintf(FINFO, "get_local_name count=%d %s\n",
505 file_total, NS(dest_path));
508 if (!dest_path || list_only)
511 if (daemon_filter_list.head) {
512 char *slash = strrchr(dest_path, '/');
513 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
517 if ((*dest_path != '.' || dest_path[1] != '\0')
518 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
519 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
520 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
522 exit_cleanup(RERR_FILESELECT);
528 /* See what currently exists at the destination. */
529 if ((statret = do_stat(dest_path, &st)) == 0) {
530 /* If the destination is a dir, enter it and use mode 1. */
531 if (S_ISDIR(st.st_mode)) {
532 if (!change_dir(dest_path, CD_NORMAL)) {
533 rsyserr(FERROR, errno, "change_dir#1 %s failed",
534 full_fname(dest_path));
535 exit_cleanup(RERR_FILESELECT);
539 if (file_total > 1) {
541 "ERROR: destination must be a directory when"
542 " copying more than 1 file\n");
543 exit_cleanup(RERR_FILESELECT);
545 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
547 "ERROR: cannot overwrite non-directory"
548 " with a directory\n");
549 exit_cleanup(RERR_FILESELECT);
551 } else if (errno != ENOENT) {
552 /* If we don't know what's at the destination, fail. */
553 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
554 full_fname(dest_path));
555 exit_cleanup(RERR_FILESELECT);
558 cp = strrchr(dest_path, '/');
560 /* If we need a destination directory because the transfer is not
561 * of a single non-directory or the user has requested one via a
562 * destination path ending in a slash, create one and use mode 1. */
563 if (file_total > 1 || (cp && !cp[1])) {
564 /* Lop off the final slash (if any). */
570 "ERROR: destination path is not a directory\n");
571 exit_cleanup(RERR_SYNTAX);
574 if (mkdir_defmode(dest_path) != 0) {
575 rsyserr(FERROR, errno, "mkdir %s failed",
576 full_fname(dest_path));
577 exit_cleanup(RERR_FILEIO);
580 if (flist->high >= flist->low
581 && strcmp(flist->files[flist->low]->basename, ".") == 0)
582 flist->files[0]->flags |= FLAG_DIR_CREATED;
585 rprintf(FINFO, "created directory %s\n", dest_path);
588 /* Indicate that dest dir doesn't really exist. */
592 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
593 rsyserr(FERROR, errno, "change_dir#2 %s failed",
594 full_fname(dest_path));
595 exit_cleanup(RERR_FILESELECT);
601 /* Otherwise, we are writing a single file, possibly on top of an
602 * existing non-directory. Change to the item's parent directory
603 * (if it has a path component), return the basename of the
604 * destination file as the local name, and use mode 2. */
612 if (!change_dir(dest_path, CD_NORMAL)) {
613 rsyserr(FERROR, errno, "change_dir#3 %s failed",
614 full_fname(dest_path));
615 exit_cleanup(RERR_FILESELECT);
622 /* This function checks on our alternate-basis directories. If we're in
623 * dry-run mode and the destination dir does not yet exist, we'll try to
624 * tweak any dest-relative paths to make them work for a dry-run (the
625 * destination dir must be in curr_dir[] when this function is called).
626 * We also warn about any arg that is non-existent or not a directory. */
627 static void check_alt_basis_dirs(void)
630 char **dir_p, *slash = strrchr(curr_dir, '/');
632 for (dir_p = basis_dir; *dir_p; dir_p++) {
633 if (dry_run > 1 && **dir_p != '/') {
634 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
635 char *new = new_array(char, len);
637 out_of_memory("check_alt_basis_dirs");
638 if (slash && strncmp(*dir_p, "../", 3) == 0) {
639 /* We want to remove only one leading "../" prefix for
640 * the directory we couldn't create in dry-run mode:
641 * this ensures that any other ".." references get
642 * evaluated the same as they would for a live copy. */
644 pathjoin(new, len, curr_dir, *dir_p + 3);
647 pathjoin(new, len, curr_dir, *dir_p);
650 if (do_stat(*dir_p, &st) < 0) {
651 rprintf(FWARNING, "%s arg does not exist: %s\n",
652 dest_option, *dir_p);
653 } else if (!S_ISDIR(st.st_mode)) {
654 rprintf(FWARNING, "%s arg is not a dir: %s\n",
655 dest_option, *dir_p);
660 /* This is only called by the sender. */
661 static void read_final_goodbye(int f_in)
665 char xname[MAXPATHLEN];
667 if (protocol_version < 29)
670 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
675 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
677 exit_cleanup(RERR_PROTOCOL);
681 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
683 struct file_list *flist;
687 rprintf(FINFO, "server_sender starting pid=%ld\n",
691 if (am_daemon && lp_write_only(module_id)) {
692 rprintf(FERROR, "ERROR: module is write only\n");
693 exit_cleanup(RERR_SYNTAX);
696 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
698 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
699 remove_source_files == 1 ? "source" : "sent");
700 exit_cleanup(RERR_SYNTAX);
704 if (!relative_paths) {
705 if (!change_dir(dir, CD_NORMAL)) {
706 rsyserr(FERROR, errno, "change_dir#3 %s failed",
708 exit_cleanup(RERR_FILESELECT);
714 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
720 flist = send_file_list(f_out,argc,argv);
721 if (!flist || flist->used == 0)
724 io_start_buffering_in(f_in);
726 send_files(f_in, f_out);
727 io_flush(FULL_FLUSH);
729 if (protocol_version >= 24)
730 read_final_goodbye(f_in);
731 io_flush(FULL_FLUSH);
736 static int do_recv(int f_in, int f_out, char *local_name)
742 /* The receiving side mustn't obey this, or an existing symlink that
743 * points to an identical file won't be replaced by the referent. */
744 copy_links = copy_dirlinks = copy_unsafe_links = 0;
746 #ifdef SUPPORT_HARD_LINKS
747 if (preserve_hard_links && !inc_recurse)
748 match_hard_links(first_flist);
751 if (fd_pair(error_pipe) < 0) {
752 rsyserr(FERROR, errno, "pipe failed in do_recv");
753 exit_cleanup(RERR_IPC);
756 io_flush(NORMAL_FLUSH);
758 if ((pid = do_fork()) == -1) {
759 rsyserr(FERROR, errno, "fork failed in do_recv");
760 exit_cleanup(RERR_IPC);
766 close(error_pipe[0]);
770 /* we can't let two processes write to the socket at one time */
771 io_end_multiplex_out();
773 /* set place to send errors */
774 set_msg_fd_out(error_pipe[1]);
775 io_start_buffering_out(error_pipe[1]);
777 recv_files(f_in, local_name);
778 io_flush(FULL_FLUSH);
781 send_msg(MSG_DONE, "", 1, 0);
782 write_varlong(error_pipe[1], stats.total_read, 3);
783 io_flush(FULL_FLUSH);
785 /* Handle any keep-alive packets from the post-processing work
786 * that the generator does. */
787 if (protocol_version >= 29) {
790 char xname[MAXPATHLEN];
792 kluge_around_eof = -1;
794 /* This should only get stopped via a USR2 signal. */
795 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
798 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
800 exit_cleanup(RERR_PROTOCOL);
803 /* Finally, we go to sleep until our parent kills us with a
804 * USR2 signal. We sleep for a short time, as on some OSes
805 * a signal won't interrupt a sleep! */
812 io_end_multiplex_in();
813 if (write_batch && !am_server)
816 close(error_pipe[1]);
820 io_start_buffering_out(f_out);
822 set_msg_fd_in(error_pipe[0]);
823 io_start_buffering_in(error_pipe[0]);
825 #ifdef SUPPORT_HARD_LINKS
826 if (preserve_hard_links && inc_recurse) {
827 struct file_list *flist;
828 for (flist = first_flist; flist; flist = flist->next)
829 match_hard_links(flist);
833 generate_files(f_out, local_name);
836 io_flush(FULL_FLUSH);
837 if (protocol_version >= 24) {
838 /* send a final goodbye message */
839 write_ndx(f_out, NDX_DONE);
841 io_flush(FULL_FLUSH);
845 wait_process_with_flush(pid, &exit_code);
849 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
852 struct file_list *flist;
853 char *local_name = NULL;
854 int save_verbose = verbose;
856 if (filesfrom_fd >= 0) {
857 /* We can't mix messages with files-from data on the socket,
858 * so temporarily turn off verbose messages. */
863 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
864 argc, (long)getpid());
867 if (am_daemon && lp_read_only(module_id)) {
868 rprintf(FERROR,"ERROR: module is read only\n");
869 exit_cleanup(RERR_SYNTAX);
877 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
878 rsyserr(FERROR, errno, "change_dir#4 %s failed",
880 exit_cleanup(RERR_FILESELECT);
884 if (protocol_version >= 30)
885 io_start_multiplex_in();
887 io_start_buffering_in(f_in);
888 recv_filter_list(f_in);
890 if (filesfrom_fd >= 0) {
891 /* We need to send the files-from names to the sender at the
892 * same time that we receive the file-list from them, so we
893 * need the IO routines to automatically write out the names
894 * onto our f_out socket as we read the file-list. This
895 * avoids both deadlock and extra delays/buffers. */
896 io_set_filesfrom_fds(filesfrom_fd, f_out);
900 flist = recv_file_list(f_in);
902 rprintf(FERROR,"server_recv: recv_file_list error\n");
903 exit_cleanup(RERR_FILESELECT);
905 if (inc_recurse && file_total == 1)
906 recv_additional_file_list(f_in);
907 verbose = save_verbose;
910 local_name = get_local_name(flist,argv[0]);
912 /* Now that we know what our destination directory turned out to be,
913 * we can sanitize the --link-/copy-/compare-dest args correctly. */
914 if (sanitize_paths) {
916 for (dir_p = basis_dir; *dir_p; dir_p++)
917 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
919 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
921 check_alt_basis_dirs();
923 if (daemon_filter_list.head) {
925 struct filter_list_struct *elp = &daemon_filter_list;
927 for (dir_p = basis_dir; *dir_p; dir_p++) {
930 dir += module_dirlen;
931 if (check_filter(elp, FLOG, dir, 1) < 0)
932 goto options_rejected;
934 if (partial_dir && *partial_dir == '/'
935 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
938 "Your options have been rejected by the server.\n");
939 exit_cleanup(RERR_SYNTAX);
943 exit_code = do_recv(f_in, f_out, local_name);
944 exit_cleanup(exit_code);
948 int child_main(int argc, char *argv[])
950 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
955 void start_server(int f_in, int f_out, int argc, char *argv[])
957 set_nonblocking(f_in);
958 set_nonblocking(f_out);
960 io_set_sock_fds(f_in, f_out);
961 setup_protocol(f_out, f_in);
963 if (protocol_version >= 23)
964 io_start_multiplex_out();
967 keep_dirlinks = 0; /* Must be disabled on the sender. */
968 if (need_messages_from_generator)
969 io_start_multiplex_in();
970 recv_filter_list(f_in);
971 do_server_sender(f_in, f_out, argc, argv);
973 do_server_recv(f_in, f_out, argc, argv);
979 * This is called once the connection has been negotiated. It is used
980 * for rsyncd, remote-shell, and local connections.
982 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
984 struct file_list *flist = NULL;
985 int exit_code = 0, exit_code2 = 0;
986 char *local_name = NULL;
988 cleanup_child_pid = pid;
990 set_nonblocking(f_in);
991 set_nonblocking(f_out);
994 io_set_sock_fds(f_in, f_out);
995 setup_protocol(f_out,f_in);
997 /* We set our stderr file handle to blocking because ssh might have
998 * set it to non-blocking. This can be particularly troublesome if
999 * stderr is a clone of stdout, because ssh would have set our stdout
1000 * to non-blocking at the same time (which can easily cause us to lose
1001 * output from our print statements). This kluge shouldn't cause ssh
1002 * any problems for how we use it. Note also that we delayed setting
1003 * this until after the above protocol setup so that we know for sure
1004 * that ssh is done twiddling its file descriptors. */
1005 set_blocking(STDERR_FILENO);
1008 keep_dirlinks = 0; /* Must be disabled on the sender. */
1009 if (protocol_version >= 30)
1010 io_start_multiplex_out();
1012 io_start_buffering_out(f_out);
1013 if (!filesfrom_host)
1014 set_msg_fd_in(f_in);
1015 send_filter_list(f_out);
1017 filesfrom_fd = f_in;
1019 if (write_batch && !am_server)
1020 start_write_batch(f_out);
1021 flist = send_file_list(f_out, argc, argv);
1023 rprintf(FINFO,"file list sent\n");
1025 if (protocol_version >= 23)
1026 io_start_multiplex_in();
1028 io_flush(NORMAL_FLUSH);
1029 send_files(f_in, f_out);
1030 io_flush(FULL_FLUSH);
1032 if (protocol_version >= 24)
1033 read_final_goodbye(f_in);
1036 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1037 io_flush(FULL_FLUSH);
1038 wait_process_with_flush(pid, &exit_code);
1041 io_flush(FULL_FLUSH);
1042 exit_cleanup(exit_code);
1046 if (protocol_version >= 23)
1047 io_start_multiplex_in();
1048 if (need_messages_from_generator)
1049 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]);
1068 check_alt_basis_dirs();
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, &dummy_host, &dummy_port)) {
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;
1165 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1166 if (path && filesfrom_host && *filesfrom_host
1167 && strcmp(filesfrom_host, shell_machine) != 0) {
1169 "--files-from hostname is not the same as the transfer hostname\n");
1170 exit_cleanup(RERR_SYNTAX);
1172 if (!path) { /* no hostspec found, so src & dest are local */
1174 if (filesfrom_host) {
1176 "--files-from cannot be remote when the transfer is local\n");
1177 exit_cleanup(RERR_SYNTAX);
1179 shell_machine = NULL;
1180 } else { /* hostspec was found, so dest is remote */
1183 daemon_over_rsh = shell_cmd ? 1 : -1;
1186 } else { /* read_batch */
1188 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1189 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1190 exit_cleanup(RERR_SYNTAX);
1192 remote_argv = argv += argc - 1;
1193 remote_argc = argc = 1;
1198 int dummy_port = rsync_port;
1200 /* For local source, extra source args must not have hostspec. */
1201 for (i = 1; i < argc; i++) {
1202 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1203 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1204 exit_cleanup(RERR_SYNTAX);
1209 int dummy_port = rsync_port;
1211 /* For remote source, any extra source args must have either
1212 * the same hostname or an empty hostname. */
1213 for (i = 1; i < remote_argc; i++) {
1214 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1216 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1217 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1218 exit_cleanup(RERR_SYNTAX);
1220 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1221 rprintf(FERROR, "All source args must come from the same machine.\n");
1222 exit_cleanup(RERR_SYNTAX);
1224 if (rsync_port != dummy_port) {
1225 if (!rsync_port || !dummy_port)
1226 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1228 rprintf(FERROR, "All source args must use the same port number.\n");
1229 exit_cleanup(RERR_SYNTAX);
1231 remote_argv[i] = arg;
1235 if (daemon_over_rsh < 0)
1236 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1238 if (password_file && !daemon_over_rsh) {
1239 rprintf(FERROR, "The --password-file option may only be "
1240 "used when accessing an rsync daemon.\n");
1241 exit_cleanup(RERR_SYNTAX);
1244 if (connect_timeout) {
1245 rprintf(FERROR, "The --contimeout option may only be "
1246 "used when connecting to an rsync daemon.\n");
1247 exit_cleanup(RERR_SYNTAX);
1250 if (shell_machine) {
1251 p = strrchr(shell_machine,'@');
1254 shell_user = shell_machine;
1255 shell_machine = p+1;
1260 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1261 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1262 remote_argv ? NS(remote_argv[0]) : "");
1265 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1268 /* if we're running an rsync server on the remote host over a
1269 * remote shell command, we need to do the RSYNCD protocol first */
1270 if (daemon_over_rsh) {
1272 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1277 ret = client_run(f_in, f_out, pid, argc, argv);
1286 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1288 exit_cleanup(RERR_SIGNAL1);
1291 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1297 _exit(RERR_PARTIAL);
1301 RETSIGTYPE remember_children(UNUSED(int val))
1306 /* An empty waitpid() loop was put here by Tridge and we could never
1307 * get him to explain why he put it in, so rather than taking it
1308 * out we're instead saving the child exit statuses for later use.
1309 * The waitpid() loop presumably eliminates all possibility of leaving
1310 * zombie children, maybe that's why he did it. */
1311 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1312 /* save the child's exit status */
1313 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1314 if (pid_stat_table[cnt].pid == 0) {
1315 pid_stat_table[cnt].pid = pid;
1316 pid_stat_table[cnt].status = status;
1322 #ifndef HAVE_SIGACTION
1323 signal(SIGCHLD, remember_children);
1329 * This routine catches signals and tries to send them to gdb.
1331 * Because it's called from inside a signal handler it ought not to
1332 * use too many library routines.
1334 * @todo Perhaps use "screen -X" instead/as well, to help people
1335 * debugging without easy access to X. Perhaps use an environment
1336 * variable, or just call a script?
1338 * @todo The /proc/ magic probably only works on Linux (and
1339 * Solaris?) Can we be more portable?
1341 #ifdef MAINTAINER_MODE
1342 const char *get_panic_action(void)
1344 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1349 return "xterm -display :0 -T Panic -n Panic "
1350 "-e gdb /proc/%d/exe %d";
1355 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1357 * This signal handler is only installed if we were configured with
1358 * --enable-maintainer-mode. Perhaps it should always be on and we
1359 * should just look at the environment variable, but I'm a bit leery
1360 * of a signal sending us into a busy loop.
1362 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1367 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1368 getpid(), getpid());
1370 /* Unless we failed to execute gdb, we allow the process to
1371 * continue. I'm not sure if that's right. */
1372 ret = system(cmd_buf);
1379 int main(int argc,char *argv[])
1382 int orig_argc = argc;
1383 char **orig_argv = argv;
1384 #ifdef HAVE_SIGACTION
1385 # ifdef HAVE_SIGPROCMASK
1388 sigemptyset(&sigmask);
1390 sigact.sa_flags = SA_NOCLDSTOP;
1392 SIGACTMASK(SIGUSR1, sigusr1_handler);
1393 SIGACTMASK(SIGUSR2, sigusr2_handler);
1394 SIGACTMASK(SIGCHLD, remember_children);
1395 #ifdef MAINTAINER_MODE
1396 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1397 SIGACTMASK(SIGFPE, rsync_panic_handler);
1398 SIGACTMASK(SIGABRT, rsync_panic_handler);
1399 SIGACTMASK(SIGBUS, rsync_panic_handler);
1402 starttime = time(NULL);
1404 am_root = our_uid == 0;
1406 memset(&stats, 0, sizeof(stats));
1410 exit_cleanup(RERR_SYNTAX);
1413 /* we set a 0 umask so that correct file permissions can be
1415 orig_umask = umask(0);
1417 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1418 setlocale(LC_CTYPE, "");
1421 if (!parse_arguments(&argc, (const char ***) &argv)) {
1422 /* FIXME: We ought to call the same error-handling
1423 * code here, rather than relying on getopt. */
1425 exit_cleanup(RERR_SYNTAX);
1428 SIGACTMASK(SIGINT, sig_int);
1429 SIGACTMASK(SIGHUP, sig_int);
1430 SIGACTMASK(SIGTERM, sig_int);
1431 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1432 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1435 /* Ignore SIGPIPE; we consistently check error codes and will
1437 SIGACTION(SIGPIPE, SIG_IGN);
1439 SIGACTION(SIGXFSZ, SIG_IGN);
1442 /* Initialize change_dir() here because on some old systems getcwd
1443 * (implemented by forking "pwd" and reading its output) doesn't
1444 * work when there are other child processes. Also, on all systems
1445 * that implement getcwd that way "pwd" can't be found after chroot. */
1446 change_dir(NULL, CD_NORMAL);
1450 if ((write_batch || read_batch) && !am_server) {
1452 write_batch_shell_file(orig_argc, orig_argv, argc);
1454 if (read_batch && strcmp(batch_name, "-") == 0)
1455 batch_fd = STDIN_FILENO;
1457 batch_fd = do_open(batch_name,
1458 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1459 : O_RDONLY, S_IRUSR | S_IWUSR);
1462 rsyserr(FERROR, errno, "Batch file %s open error",
1463 full_fname(batch_name));
1464 exit_cleanup(RERR_FILEIO);
1467 read_stream_flags(batch_fd);
1469 write_stream_flags(batch_fd);
1471 if (write_batch < 0)
1478 } else if (am_daemon)
1479 return daemon_main();
1481 if (am_server && protect_args) {
1482 char buf[MAXPATHLEN];
1484 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1485 if (!parse_arguments(&argc, (const char ***) &argv)) {
1487 exit_cleanup(RERR_SYNTAX);
1493 exit_cleanup(RERR_SYNTAX);
1497 set_nonblocking(STDIN_FILENO);
1498 set_nonblocking(STDOUT_FILENO);
1500 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1501 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1504 ret = start_client(argc, argv);
1506 exit_cleanup(RERR_STARTCLIENT);