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[MAX_BASIS_DIRS+1];
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 /* Treat an empty string as a copy into the current directory. */
515 if (daemon_filter_list.head) {
516 char *slash = strrchr(dest_path, '/');
517 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
521 if ((*dest_path != '.' || dest_path[1] != '\0')
522 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
523 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
524 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
526 exit_cleanup(RERR_FILESELECT);
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 (!change_dir(dest_path, CD_NORMAL)) {
537 rsyserr(FERROR, errno, "change_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 (flist->high >= flist->low
585 && strcmp(flist->files[flist->low]->basename, ".") == 0)
586 flist->files[0]->flags |= FLAG_DIR_CREATED;
589 rprintf(FINFO, "created directory %s\n", dest_path);
592 /* Indicate that dest dir doesn't really exist. */
596 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
597 rsyserr(FERROR, errno, "change_dir#2 %s failed",
598 full_fname(dest_path));
599 exit_cleanup(RERR_FILESELECT);
605 /* Otherwise, we are writing a single file, possibly on top of an
606 * existing non-directory. Change to the item's parent directory
607 * (if it has a path component), return the basename of the
608 * destination file as the local name, and use mode 2. */
616 if (!change_dir(dest_path, CD_NORMAL)) {
617 rsyserr(FERROR, errno, "change_dir#3 %s failed",
618 full_fname(dest_path));
619 exit_cleanup(RERR_FILESELECT);
626 /* This function checks on our alternate-basis directories. If we're in
627 * dry-run mode and the destination dir does not yet exist, we'll try to
628 * tweak any dest-relative paths to make them work for a dry-run (the
629 * destination dir must be in curr_dir[] when this function is called).
630 * We also warn about any arg that is non-existent or not a directory. */
631 static void check_alt_basis_dirs(void)
634 char **dir_p, *slash = strrchr(curr_dir, '/');
636 for (dir_p = basis_dir; *dir_p; dir_p++) {
637 if (dry_run > 1 && **dir_p != '/') {
638 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
639 char *new = new_array(char, len);
641 out_of_memory("check_alt_basis_dirs");
642 if (slash && strncmp(*dir_p, "../", 3) == 0) {
643 /* We want to remove only one leading "../" prefix for
644 * the directory we couldn't create in dry-run mode:
645 * this ensures that any other ".." references get
646 * evaluated the same as they would for a live copy. */
648 pathjoin(new, len, curr_dir, *dir_p + 3);
651 pathjoin(new, len, curr_dir, *dir_p);
654 if (do_stat(*dir_p, &st) < 0) {
655 rprintf(FWARNING, "%s arg does not exist: %s\n",
656 dest_option, *dir_p);
657 } else if (!S_ISDIR(st.st_mode)) {
658 rprintf(FWARNING, "%s arg is not a dir: %s\n",
659 dest_option, *dir_p);
664 /* This is only called by the sender. */
665 static void read_final_goodbye(int f_in)
669 char xname[MAXPATHLEN];
671 if (protocol_version < 29)
674 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
679 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
681 exit_cleanup(RERR_PROTOCOL);
685 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
687 struct file_list *flist;
691 rprintf(FINFO, "server_sender starting pid=%ld\n",
695 if (am_daemon && lp_write_only(module_id)) {
696 rprintf(FERROR, "ERROR: module is write only\n");
697 exit_cleanup(RERR_SYNTAX);
700 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
702 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
703 remove_source_files == 1 ? "source" : "sent");
704 exit_cleanup(RERR_SYNTAX);
708 if (!relative_paths) {
709 if (!change_dir(dir, CD_NORMAL)) {
710 rsyserr(FERROR, errno, "change_dir#3 %s failed",
712 exit_cleanup(RERR_FILESELECT);
718 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
724 flist = send_file_list(f_out,argc,argv);
725 if (!flist || flist->used == 0)
728 io_start_buffering_in(f_in);
730 send_files(f_in, f_out);
731 io_flush(FULL_FLUSH);
733 if (protocol_version >= 24)
734 read_final_goodbye(f_in);
735 io_flush(FULL_FLUSH);
740 static int do_recv(int f_in, int f_out, char *local_name)
746 /* The receiving side mustn't obey this, or an existing symlink that
747 * points to an identical file won't be replaced by the referent. */
748 copy_links = copy_dirlinks = copy_unsafe_links = 0;
750 #ifdef SUPPORT_HARD_LINKS
751 if (preserve_hard_links && !inc_recurse)
752 match_hard_links(first_flist);
755 if (fd_pair(error_pipe) < 0) {
756 rsyserr(FERROR, errno, "pipe failed in do_recv");
757 exit_cleanup(RERR_IPC);
760 io_flush(NORMAL_FLUSH);
762 if ((pid = do_fork()) == -1) {
763 rsyserr(FERROR, errno, "fork failed in do_recv");
764 exit_cleanup(RERR_IPC);
770 close(error_pipe[0]);
774 /* we can't let two processes write to the socket at one time */
775 io_end_multiplex_out();
777 /* set place to send errors */
778 set_msg_fd_out(error_pipe[1]);
779 io_start_buffering_out(error_pipe[1]);
781 recv_files(f_in, local_name);
782 io_flush(FULL_FLUSH);
785 send_msg(MSG_DONE, "", 1, 0);
786 write_varlong(error_pipe[1], stats.total_read, 3);
787 io_flush(FULL_FLUSH);
789 /* Handle any keep-alive packets from the post-processing work
790 * that the generator does. */
791 if (protocol_version >= 29) {
794 char xname[MAXPATHLEN];
796 kluge_around_eof = -1;
798 /* This should only get stopped via a USR2 signal. */
799 read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
802 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
804 exit_cleanup(RERR_PROTOCOL);
807 /* Finally, we go to sleep until our parent kills us with a
808 * USR2 signal. We sleep for a short time, as on some OSes
809 * a signal won't interrupt a sleep! */
816 io_end_multiplex_in();
817 if (write_batch && !am_server)
820 close(error_pipe[1]);
824 io_start_buffering_out(f_out);
826 set_msg_fd_in(error_pipe[0]);
827 io_start_buffering_in(error_pipe[0]);
829 #ifdef SUPPORT_HARD_LINKS
830 if (preserve_hard_links && inc_recurse) {
831 struct file_list *flist;
832 for (flist = first_flist; flist; flist = flist->next)
833 match_hard_links(flist);
837 generate_files(f_out, local_name);
840 io_flush(FULL_FLUSH);
841 if (protocol_version >= 24) {
842 /* send a final goodbye message */
843 write_ndx(f_out, NDX_DONE);
845 io_flush(FULL_FLUSH);
849 wait_process_with_flush(pid, &exit_code);
853 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
856 struct file_list *flist;
857 char *local_name = NULL;
858 int save_verbose = verbose;
860 if (filesfrom_fd >= 0) {
861 /* We can't mix messages with files-from data on the socket,
862 * so temporarily turn off verbose messages. */
867 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
868 argc, (long)getpid());
871 if (am_daemon && lp_read_only(module_id)) {
872 rprintf(FERROR,"ERROR: module is read only\n");
873 exit_cleanup(RERR_SYNTAX);
881 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
882 rsyserr(FERROR, errno, "change_dir#4 %s failed",
884 exit_cleanup(RERR_FILESELECT);
888 if (protocol_version >= 30)
889 io_start_multiplex_in();
891 io_start_buffering_in(f_in);
892 recv_filter_list(f_in);
894 if (filesfrom_fd >= 0) {
895 /* We need to send the files-from names to the sender at the
896 * same time that we receive the file-list from them, so we
897 * need the IO routines to automatically write out the names
898 * onto our f_out socket as we read the file-list. This
899 * avoids both deadlock and extra delays/buffers. */
900 io_set_filesfrom_fds(filesfrom_fd, f_out);
904 flist = recv_file_list(f_in);
906 rprintf(FERROR,"server_recv: recv_file_list error\n");
907 exit_cleanup(RERR_FILESELECT);
909 if (inc_recurse && file_total == 1)
910 recv_additional_file_list(f_in);
911 verbose = save_verbose;
914 local_name = get_local_name(flist,argv[0]);
916 /* Now that we know what our destination directory turned out to be,
917 * we can sanitize the --link-/copy-/compare-dest args correctly. */
918 if (sanitize_paths) {
920 for (dir_p = basis_dir; *dir_p; dir_p++)
921 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
923 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
925 check_alt_basis_dirs();
927 if (daemon_filter_list.head) {
929 struct filter_list_struct *elp = &daemon_filter_list;
931 for (dir_p = basis_dir; *dir_p; dir_p++) {
934 dir += module_dirlen;
935 if (check_filter(elp, FLOG, dir, 1) < 0)
936 goto options_rejected;
938 if (partial_dir && *partial_dir == '/'
939 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
942 "Your options have been rejected by the server.\n");
943 exit_cleanup(RERR_SYNTAX);
947 exit_code = do_recv(f_in, f_out, local_name);
948 exit_cleanup(exit_code);
952 int child_main(int argc, char *argv[])
954 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
959 void start_server(int f_in, int f_out, int argc, char *argv[])
961 set_nonblocking(f_in);
962 set_nonblocking(f_out);
964 io_set_sock_fds(f_in, f_out);
965 setup_protocol(f_out, f_in);
967 if (protocol_version >= 23)
968 io_start_multiplex_out();
971 keep_dirlinks = 0; /* Must be disabled on the sender. */
972 if (need_messages_from_generator)
973 io_start_multiplex_in();
974 recv_filter_list(f_in);
975 do_server_sender(f_in, f_out, argc, argv);
977 do_server_recv(f_in, f_out, argc, argv);
983 * This is called once the connection has been negotiated. It is used
984 * for rsyncd, remote-shell, and local connections.
986 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
988 struct file_list *flist = NULL;
989 int exit_code = 0, exit_code2 = 0;
990 char *local_name = NULL;
992 cleanup_child_pid = pid;
994 set_nonblocking(f_in);
995 set_nonblocking(f_out);
998 io_set_sock_fds(f_in, f_out);
999 setup_protocol(f_out,f_in);
1001 /* We set our stderr file handle to blocking because ssh might have
1002 * set it to non-blocking. This can be particularly troublesome if
1003 * stderr is a clone of stdout, because ssh would have set our stdout
1004 * to non-blocking at the same time (which can easily cause us to lose
1005 * output from our print statements). This kluge shouldn't cause ssh
1006 * any problems for how we use it. Note also that we delayed setting
1007 * this until after the above protocol setup so that we know for sure
1008 * that ssh is done twiddling its file descriptors. */
1009 set_blocking(STDERR_FILENO);
1012 keep_dirlinks = 0; /* Must be disabled on the sender. */
1013 if (protocol_version >= 30)
1014 io_start_multiplex_out();
1016 io_start_buffering_out(f_out);
1017 if (!filesfrom_host)
1018 set_msg_fd_in(f_in);
1019 send_filter_list(f_out);
1021 filesfrom_fd = f_in;
1023 if (write_batch && !am_server)
1024 start_write_batch(f_out);
1025 flist = send_file_list(f_out, argc, argv);
1027 rprintf(FINFO,"file list sent\n");
1029 if (protocol_version >= 23)
1030 io_start_multiplex_in();
1032 io_flush(NORMAL_FLUSH);
1033 send_files(f_in, f_out);
1034 io_flush(FULL_FLUSH);
1036 if (protocol_version >= 24)
1037 read_final_goodbye(f_in);
1040 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1041 io_flush(FULL_FLUSH);
1042 wait_process_with_flush(pid, &exit_code);
1045 io_flush(FULL_FLUSH);
1046 exit_cleanup(exit_code);
1050 if (protocol_version >= 23)
1051 io_start_multiplex_in();
1052 if (need_messages_from_generator)
1053 io_start_multiplex_out();
1056 send_filter_list(read_batch ? -1 : f_out);
1058 if (filesfrom_fd >= 0) {
1059 io_set_filesfrom_fds(filesfrom_fd, f_out);
1063 if (write_batch && !am_server)
1064 start_write_batch(f_in);
1065 flist = recv_file_list(f_in);
1066 if (inc_recurse && file_total == 1)
1067 recv_additional_file_list(f_in);
1069 if (flist && flist->used > 0) {
1070 local_name = get_local_name(flist, argv[0]);
1072 check_alt_basis_dirs();
1074 exit_code2 = do_recv(f_in, f_out, local_name);
1082 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1083 io_flush(FULL_FLUSH);
1084 wait_process_with_flush(pid, &exit_code);
1087 return MAX(exit_code, exit_code2);
1090 static int copy_argv(char *argv[])
1094 for (i = 0; argv[i]; i++) {
1095 if (!(argv[i] = strdup(argv[i]))) {
1096 rprintf (FERROR, "out of memory at %s(%d)\n",
1097 __FILE__, __LINE__);
1107 * Start a client for either type of remote connection. Work out
1108 * whether the arguments request a remote shell or rsyncd connection,
1109 * and call the appropriate connection function, then run_client.
1111 * Calls either start_socket_client (for sockets) or do_cmd and
1112 * client_run (for ssh).
1114 static int start_client(int argc, char *argv[])
1116 char *p, *shell_machine = NULL, *shell_user = NULL;
1123 /* Don't clobber argv[] so that ps(1) can still show the right
1125 if ((ret = copy_argv(argv)) != 0)
1128 if (!read_batch) { /* for read_batch, NO source is specified */
1129 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1130 if (path) { /* source is remote */
1137 if (argc == 1 || **argv == ':')
1138 argc = 0; /* no dest arg */
1139 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1141 "The source and destination cannot both be remote.\n");
1142 exit_cleanup(RERR_SYNTAX);
1144 remote_argc--; /* don't count dest */
1147 if (filesfrom_host && *filesfrom_host
1148 && strcmp(filesfrom_host, shell_machine) != 0) {
1150 "--files-from hostname is not the same as the transfer hostname\n");
1151 exit_cleanup(RERR_SYNTAX);
1155 daemon_over_rsh = shell_cmd ? 1 : -1;
1156 } else { /* source is local, check dest arg */
1161 remote_argv = argv + argc;
1163 static char *dotarg[1] = { "." };
1165 remote_argv = dotarg;
1169 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1170 if (path && filesfrom_host && *filesfrom_host
1171 && strcmp(filesfrom_host, shell_machine) != 0) {
1173 "--files-from hostname is not the same as the transfer hostname\n");
1174 exit_cleanup(RERR_SYNTAX);
1176 if (!path) { /* no hostspec found, so src & dest are local */
1178 if (filesfrom_host) {
1180 "--files-from cannot be remote when the transfer is local\n");
1181 exit_cleanup(RERR_SYNTAX);
1183 shell_machine = NULL;
1184 } else { /* hostspec was found, so dest is remote */
1187 daemon_over_rsh = shell_cmd ? 1 : -1;
1190 } else { /* read_batch */
1192 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1193 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1194 exit_cleanup(RERR_SYNTAX);
1196 remote_argv = argv += argc - 1;
1197 remote_argc = argc = 1;
1202 int dummy_port = rsync_port;
1204 /* For local source, extra source args must not have hostspec. */
1205 for (i = 1; i < argc; i++) {
1206 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1207 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1208 exit_cleanup(RERR_SYNTAX);
1213 int dummy_port = rsync_port;
1215 /* For remote source, any extra source args must have either
1216 * the same hostname or an empty hostname. */
1217 for (i = 1; i < remote_argc; i++) {
1218 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1220 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1221 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1222 exit_cleanup(RERR_SYNTAX);
1224 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1225 rprintf(FERROR, "All source args must come from the same machine.\n");
1226 exit_cleanup(RERR_SYNTAX);
1228 if (rsync_port != dummy_port) {
1229 if (!rsync_port || !dummy_port)
1230 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1232 rprintf(FERROR, "All source args must use the same port number.\n");
1233 exit_cleanup(RERR_SYNTAX);
1235 remote_argv[i] = arg;
1239 if (daemon_over_rsh < 0)
1240 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1242 if (password_file && !daemon_over_rsh) {
1243 rprintf(FERROR, "The --password-file option may only be "
1244 "used when accessing an rsync daemon.\n");
1245 exit_cleanup(RERR_SYNTAX);
1248 if (connect_timeout) {
1249 rprintf(FERROR, "The --contimeout option may only be "
1250 "used when connecting to an rsync daemon.\n");
1251 exit_cleanup(RERR_SYNTAX);
1254 if (shell_machine) {
1255 p = strrchr(shell_machine,'@');
1258 shell_user = shell_machine;
1259 shell_machine = p+1;
1264 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1265 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1266 remote_argv ? NS(remote_argv[0]) : "");
1269 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1272 /* if we're running an rsync server on the remote host over a
1273 * remote shell command, we need to do the RSYNCD protocol first */
1274 if (daemon_over_rsh) {
1276 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1281 ret = client_run(f_in, f_out, pid, argc, argv);
1290 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1292 exit_cleanup(RERR_SIGNAL1);
1295 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1301 _exit(RERR_PARTIAL);
1305 RETSIGTYPE remember_children(UNUSED(int val))
1310 /* An empty waitpid() loop was put here by Tridge and we could never
1311 * get him to explain why he put it in, so rather than taking it
1312 * out we're instead saving the child exit statuses for later use.
1313 * The waitpid() loop presumably eliminates all possibility of leaving
1314 * zombie children, maybe that's why he did it. */
1315 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1316 /* save the child's exit status */
1317 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1318 if (pid_stat_table[cnt].pid == 0) {
1319 pid_stat_table[cnt].pid = pid;
1320 pid_stat_table[cnt].status = status;
1326 #ifndef HAVE_SIGACTION
1327 signal(SIGCHLD, remember_children);
1333 * This routine catches signals and tries to send them to gdb.
1335 * Because it's called from inside a signal handler it ought not to
1336 * use too many library routines.
1338 * @todo Perhaps use "screen -X" instead/as well, to help people
1339 * debugging without easy access to X. Perhaps use an environment
1340 * variable, or just call a script?
1342 * @todo The /proc/ magic probably only works on Linux (and
1343 * Solaris?) Can we be more portable?
1345 #ifdef MAINTAINER_MODE
1346 const char *get_panic_action(void)
1348 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1353 return "xterm -display :0 -T Panic -n Panic "
1354 "-e gdb /proc/%d/exe %d";
1359 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1361 * This signal handler is only installed if we were configured with
1362 * --enable-maintainer-mode. Perhaps it should always be on and we
1363 * should just look at the environment variable, but I'm a bit leery
1364 * of a signal sending us into a busy loop.
1366 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1371 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1372 getpid(), getpid());
1374 /* Unless we failed to execute gdb, we allow the process to
1375 * continue. I'm not sure if that's right. */
1376 ret = system(cmd_buf);
1383 int main(int argc,char *argv[])
1386 int orig_argc = argc;
1387 char **orig_argv = argv;
1388 #ifdef HAVE_SIGACTION
1389 # ifdef HAVE_SIGPROCMASK
1392 sigemptyset(&sigmask);
1394 sigact.sa_flags = SA_NOCLDSTOP;
1396 SIGACTMASK(SIGUSR1, sigusr1_handler);
1397 SIGACTMASK(SIGUSR2, sigusr2_handler);
1398 SIGACTMASK(SIGCHLD, remember_children);
1399 #ifdef MAINTAINER_MODE
1400 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1401 SIGACTMASK(SIGFPE, rsync_panic_handler);
1402 SIGACTMASK(SIGABRT, rsync_panic_handler);
1403 SIGACTMASK(SIGBUS, rsync_panic_handler);
1406 starttime = time(NULL);
1408 am_root = our_uid == 0;
1410 memset(&stats, 0, sizeof(stats));
1414 exit_cleanup(RERR_SYNTAX);
1417 /* we set a 0 umask so that correct file permissions can be
1419 orig_umask = umask(0);
1421 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1422 setlocale(LC_CTYPE, "");
1425 if (!parse_arguments(&argc, (const char ***) &argv)) {
1426 /* FIXME: We ought to call the same error-handling
1427 * code here, rather than relying on getopt. */
1429 exit_cleanup(RERR_SYNTAX);
1432 SIGACTMASK(SIGINT, sig_int);
1433 SIGACTMASK(SIGHUP, sig_int);
1434 SIGACTMASK(SIGTERM, sig_int);
1435 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1436 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1439 /* Ignore SIGPIPE; we consistently check error codes and will
1441 SIGACTION(SIGPIPE, SIG_IGN);
1443 SIGACTION(SIGXFSZ, SIG_IGN);
1446 /* Initialize change_dir() here because on some old systems getcwd
1447 * (implemented by forking "pwd" and reading its output) doesn't
1448 * work when there are other child processes. Also, on all systems
1449 * that implement getcwd that way "pwd" can't be found after chroot. */
1450 change_dir(NULL, CD_NORMAL);
1454 if ((write_batch || read_batch) && !am_server) {
1456 write_batch_shell_file(orig_argc, orig_argv, argc);
1458 if (read_batch && strcmp(batch_name, "-") == 0)
1459 batch_fd = STDIN_FILENO;
1461 batch_fd = do_open(batch_name,
1462 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1463 : O_RDONLY, S_IRUSR | S_IWUSR);
1466 rsyserr(FERROR, errno, "Batch file %s open error",
1467 full_fname(batch_name));
1468 exit_cleanup(RERR_FILEIO);
1471 read_stream_flags(batch_fd);
1473 write_stream_flags(batch_fd);
1475 if (write_batch < 0)
1482 } else if (am_daemon)
1483 return daemon_main();
1485 if (am_server && protect_args) {
1486 char buf[MAXPATHLEN];
1488 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1489 if (!parse_arguments(&argc, (const char ***) &argv)) {
1491 exit_cleanup(RERR_SYNTAX);
1497 exit_cleanup(RERR_SYNTAX);
1501 set_nonblocking(STDIN_FILENO);
1502 set_nonblocking(STDOUT_FILENO);
1504 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1505 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1508 ret = start_client(argc, argv);
1510 exit_cleanup(RERR_STARTCLIENT);