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
36 extern int inc_recurse;
37 extern int blocking_io;
38 extern int always_checksum;
39 extern int remove_source_files;
40 extern int output_needs_newline;
41 extern int need_messages_from_generator;
42 extern int kluge_around_eof;
43 extern int got_xfer_error;
44 extern int msgs2stderr;
46 extern int copy_links;
47 extern int copy_dirlinks;
48 extern int copy_unsafe_links;
49 extern int keep_dirlinks;
50 extern int preserve_hard_links;
51 extern int protocol_version;
52 extern int file_total;
55 extern int protect_args;
56 extern int relative_paths;
57 extern int sanitize_paths;
58 extern int curr_dir_depth;
59 extern int curr_dir_len;
61 extern int rsync_port;
62 extern int whole_file;
63 extern int read_batch;
64 extern int write_batch;
66 extern int filesfrom_fd;
67 extern int connect_timeout;
68 extern pid_t cleanup_child_pid;
69 extern unsigned int module_dirlen;
70 extern struct stats stats;
71 extern char *stdout_format;
72 extern char *logfile_format;
73 extern char *filesfrom_host;
74 extern char *partial_dir;
75 extern char *dest_option;
76 extern char *rsync_path;
77 extern char *shell_cmd;
78 extern char *batch_name;
79 extern char *password_file;
80 extern char *backup_dir;
81 extern char curr_dir[MAXPATHLEN];
82 extern char backup_dir_buf[MAXPATHLEN];
83 extern char *basis_dir[MAX_BASIS_DIRS+1];
84 extern struct file_list *first_flist;
85 extern filter_rule_list daemon_filter_list;
91 int daemon_over_rsh = 0;
92 mode_t orig_umask = 0;
93 int batch_gen_fd = -1;
94 int sender_keeps_checksum = 0;
96 /* There's probably never more than at most 2 outstanding child processes,
97 * but set it higher, just in case. */
98 #define MAXCHILDPROCS 7
100 #ifdef HAVE_SIGACTION
101 # ifdef HAVE_SIGPROCMASK
102 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
104 # define SIGACTMASK(n,h) SIGACTION(n,h)
106 static struct sigaction sigact;
112 } pid_stat_table[MAXCHILDPROCS];
114 static time_t starttime, endtime;
115 static int64 total_read, total_written;
117 static void show_malloc_stats(void);
119 /* Works like waitpid(), but if we already harvested the child pid in our
120 * remember_children(), we succeed instead of returning an error. */
121 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
126 waited_pid = waitpid(pid, status_ptr, flags);
127 } while (waited_pid == -1 && errno == EINTR);
129 if (waited_pid == -1 && errno == ECHILD) {
130 /* Status of requested child no longer available: check to
131 * see if it was processed by remember_children(). */
133 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
134 if (pid == pid_stat_table[cnt].pid) {
135 *status_ptr = pid_stat_table[cnt].status;
136 pid_stat_table[cnt].pid = 0;
145 /* Wait for a process to exit, calling io_flush while waiting. */
146 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
151 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
153 io_flush(FULL_FLUSH);
156 /* TODO: If the child exited on a signal, then log an
157 * appropriate error message. Perhaps we should also accept a
158 * message describing the purpose of the child. Also indicate
159 * this to the caller so that they know something went wrong. */
160 if (waited_pid < 0) {
161 rsyserr(FERROR, errno, "waitpid");
162 *exit_code_ptr = RERR_WAITCHILD;
163 } else if (!WIFEXITED(status)) {
165 if (WCOREDUMP(status))
166 *exit_code_ptr = RERR_CRASHED;
169 if (WIFSIGNALED(status))
170 *exit_code_ptr = RERR_TERMINATED;
172 *exit_code_ptr = RERR_WAITCHILD;
174 *exit_code_ptr = WEXITSTATUS(status);
177 void write_del_stats(int f)
180 write_int(f, NDX_DEL_STATS);
182 send_msg(MSG_DEL_STATS, "", 0, 0);
183 write_varint(f, stats.deleted_files - stats.deleted_dirs
184 - stats.deleted_symlinks - stats.deleted_devices
185 - stats.deleted_specials);
186 write_varint(f, stats.deleted_dirs);
187 write_varint(f, stats.deleted_symlinks);
188 write_varint(f, stats.deleted_devices);
189 write_varint(f, stats.deleted_specials);
192 void read_del_stats(int f)
194 stats.deleted_files = read_varint(f);
195 stats.deleted_files += stats.deleted_dirs = read_varint(f);
196 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
197 stats.deleted_files += stats.deleted_devices = read_varint(f);
198 stats.deleted_files += stats.deleted_specials = read_varint(f);
201 /* This function gets called from all 3 processes. We want the client side
202 * to actually output the text, but the sender is the only process that has
203 * all the stats we need. So, if we're a client sender, we do the report.
204 * If we're a server sender, we write the stats on the supplied fd. If
205 * we're the client receiver we read the stats from the supplied fd and do
206 * the report. All processes might also generate a set of debug stats, if
207 * the verbose level is high enough (this is the only thing that the
208 * generator process and the server receiver ever do here). */
209 static void handle_stats(int f)
211 endtime = time(NULL);
213 /* Cache two stats because the read/write code can change it. */
214 total_read = stats.total_read;
215 total_written = stats.total_written;
217 if (INFO_GTE(STATS, 3)) {
218 /* These come out from every process */
227 if (f == -1 || !am_sender)
233 write_varlong30(f, total_read, 3);
234 write_varlong30(f, total_written, 3);
235 write_varlong30(f, stats.total_size, 3);
236 if (protocol_version >= 29) {
237 write_varlong30(f, stats.flist_buildtime, 3);
238 write_varlong30(f, stats.flist_xfertime, 3);
244 /* this is the client */
246 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
248 else if (!am_sender) {
249 /* Read the first two in opposite order because the meaning of
250 * read/write swaps when switching from sender to receiver. */
251 total_written = read_varlong30(f, 3);
252 total_read = read_varlong30(f, 3);
253 stats.total_size = read_varlong30(f, 3);
254 if (protocol_version >= 29) {
255 stats.flist_buildtime = read_varlong30(f, 3);
256 stats.flist_xfertime = read_varlong30(f, 3);
258 } else if (write_batch) {
259 /* The --read-batch process is going to be a client
260 * receiver, so we need to give it the stats. */
261 write_varlong30(batch_fd, total_read, 3);
262 write_varlong30(batch_fd, total_written, 3);
263 write_varlong30(batch_fd, stats.total_size, 3);
264 if (protocol_version >= 29) {
265 write_varlong30(batch_fd, stats.flist_buildtime, 3);
266 write_varlong30(batch_fd, stats.flist_xfertime, 3);
271 static void output_itemized_counts(const char *prefix, int *counts)
273 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
274 char buf[1024], *pre = " (";
276 int total = counts[0];
278 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
279 for (j = 0; j < 5; j++) {
281 len += snprintf(buf+len, sizeof buf - len - 2,
283 pre, labels[j], comma_num(counts[j]));
290 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
293 static void output_summary(void)
295 if (INFO_GTE(STATS, 2)) {
296 rprintf(FCLIENT, "\n");
297 output_itemized_counts("Number of files", &stats.num_files);
298 if (protocol_version >= 29)
299 output_itemized_counts("Number of created files", &stats.created_files);
300 if (protocol_version >= 31)
301 output_itemized_counts("Number of deleted files", &stats.deleted_files);
302 rprintf(FINFO,"Number of regular files transferred: %s\n",
303 comma_num(stats.xferred_files));
304 rprintf(FINFO,"Total file size: %s bytes\n",
305 human_num(stats.total_size));
306 rprintf(FINFO,"Total transferred file size: %s bytes\n",
307 human_num(stats.total_transferred_size));
308 rprintf(FINFO,"Literal data: %s bytes\n",
309 human_num(stats.literal_data));
310 rprintf(FINFO,"Matched data: %s bytes\n",
311 human_num(stats.matched_data));
312 rprintf(FINFO,"File list size: %s\n",
313 human_num(stats.flist_size));
314 if (stats.flist_buildtime) {
316 "File list generation time: %s seconds\n",
317 comma_dnum((double)stats.flist_buildtime / 1000, 3));
319 "File list transfer time: %s seconds\n",
320 comma_dnum((double)stats.flist_xfertime / 1000, 3));
322 rprintf(FINFO,"Total bytes sent: %s\n",
323 human_num(total_written));
324 rprintf(FINFO,"Total bytes received: %s\n",
325 human_num(total_read));
328 if (INFO_GTE(STATS, 1)) {
329 rprintf(FCLIENT, "\n");
331 "sent %s bytes received %s bytes %s bytes/sec\n",
332 human_num(total_written), human_num(total_read),
333 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
334 rprintf(FINFO, "total size is %s speedup is %s%s\n",
335 human_num(stats.total_size),
336 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
337 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
346 * If our C library can get malloc statistics, then show them to FINFO
348 static void show_malloc_stats(void)
355 rprintf(FCLIENT, "\n");
356 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
357 getpid(), am_server ? "server " : "",
358 am_daemon ? "daemon " : "", who_am_i());
359 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
361 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
363 rprintf(FINFO, " smblks: %10ld\n",
365 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
367 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
369 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
370 (long)mi.arena + mi.hblkhd);
371 rprintf(FINFO, " usmblks: %10ld\n",
373 rprintf(FINFO, " fsmblks: %10ld\n",
375 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
377 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
379 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
381 #endif /* HAVE_MALLINFO */
385 /* Start the remote shell. cmd may be NULL to use the default. */
386 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
387 int *f_in_p, int *f_out_p)
390 char *args[MAX_ARGS];
394 if (!read_batch && !local_server) {
395 char *t, *f, in_quote = '\0';
396 char *rsh_env = getenv(RSYNC_RSH_ENV);
401 cmd = strdup(cmd); /* MEMORY LEAK */
405 for (t = f = cmd; *f; f++) {
408 /* Comparison leaves rooms for server_options(). */
409 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
412 while (*f != ' ' || in_quote) {
416 "Missing trailing-%c in remote-shell command.\n",
418 exit_cleanup(RERR_SYNTAX);
423 if (*f == '\'' || *f == '"') {
428 if (*f == in_quote && *++f != in_quote) {
438 /* check to see if we've already been given '-l user' in
439 * the remote-shell command */
440 for (i = 0; i < argc-1; i++) {
441 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
446 /* remsh (on HPUX) takes the arguments the other way around */
447 args[argc++] = machine;
448 if (user && !(daemon_over_rsh && dash_l_set)) {
453 if (user && !(daemon_over_rsh && dash_l_set)) {
457 args[argc++] = machine;
460 args[argc++] = rsync_path;
462 if (blocking_io < 0) {
464 if ((cp = strrchr(cmd, '/')) != NULL)
468 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
472 server_options(args,&argc);
474 if (argc >= MAX_ARGS - 2)
480 if (!daemon_over_rsh) {
481 while (remote_argc > 0) {
482 if (argc >= MAX_ARGS - 1) {
484 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
485 exit_cleanup(RERR_SYNTAX);
487 args[argc++] = *remote_argv++;
494 if (DEBUG_GTE(CMD, 2)) {
495 for (i = 0; i < argc; i++)
496 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
497 rprintf(FCLIENT, "\n");
501 int from_gen_pipe[2];
502 set_allow_inc_recurse();
503 if (fd_pair(from_gen_pipe) < 0) {
504 rsyserr(FERROR, errno, "pipe");
505 exit_cleanup(RERR_IPC);
507 batch_gen_fd = from_gen_pipe[0];
508 *f_out_p = from_gen_pipe[1];
510 pid = (pid_t)-1; /* no child pid */
514 } else if (local_server) {
515 /* If the user didn't request --[no-]whole-file, force
516 * it on, but only if we're not batch processing. */
517 if (whole_file < 0 && !write_batch)
519 set_allow_inc_recurse();
520 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
525 pid = piped_child(args, f_in_p, f_out_p);
529 if (protect_args && !daemon_over_rsh)
530 send_protected_args(*f_out_p, args);
536 out_of_memory("do_cmd");
537 return 0; /* not reached */
540 /* The receiving side operates in one of two modes:
542 * 1. it receives any number of files into a destination directory,
543 * placing them according to their names in the file-list.
545 * 2. it receives a single file and saves it using the name in the
546 * destination path instead of its file-list name. This requires a
547 * "local name" for writing out the destination file.
549 * So, our task is to figure out what mode/local-name we need.
550 * For mode 1, we change into the destination directory and return NULL.
551 * For mode 2, we change into the directory containing the destination
552 * file (if we aren't already there) and return the local-name. */
553 static char *get_local_name(struct file_list *flist, char *dest_path)
559 if (DEBUG_GTE(RECV, 1)) {
560 rprintf(FINFO, "get_local_name count=%d %s\n",
561 file_total, NS(dest_path));
564 if (!dest_path || list_only)
567 if (daemon_filter_list.head) {
568 char *slash = strrchr(dest_path, '/');
569 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
573 if ((*dest_path != '.' || dest_path[1] != '\0')
574 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
575 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
576 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
578 exit_cleanup(RERR_FILESELECT);
584 /* See what currently exists at the destination. */
585 if ((statret = do_stat(dest_path, &st)) == 0) {
586 /* If the destination is a dir, enter it and use mode 1. */
587 if (S_ISDIR(st.st_mode)) {
588 if (!change_dir(dest_path, CD_NORMAL)) {
589 rsyserr(FERROR, errno, "change_dir#1 %s failed",
590 full_fname(dest_path));
591 exit_cleanup(RERR_FILESELECT);
595 if (file_total > 1) {
597 "ERROR: destination must be a directory when"
598 " copying more than 1 file\n");
599 exit_cleanup(RERR_FILESELECT);
601 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
603 "ERROR: cannot overwrite non-directory"
604 " with a directory\n");
605 exit_cleanup(RERR_FILESELECT);
607 } else if (errno != ENOENT) {
608 /* If we don't know what's at the destination, fail. */
609 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
610 full_fname(dest_path));
611 exit_cleanup(RERR_FILESELECT);
614 cp = strrchr(dest_path, '/');
616 /* If we need a destination directory because the transfer is not
617 * of a single non-directory or the user has requested one via a
618 * destination path ending in a slash, create one and use mode 1. */
619 if (file_total > 1 || (cp && !cp[1])) {
620 /* Lop off the final slash (if any). */
626 "ERROR: destination path is not a directory\n");
627 exit_cleanup(RERR_SYNTAX);
630 if (mkdir_defmode(dest_path) != 0) {
631 rsyserr(FERROR, errno, "mkdir %s failed",
632 full_fname(dest_path));
633 exit_cleanup(RERR_FILEIO);
636 if (flist->high >= flist->low
637 && strcmp(flist->files[flist->low]->basename, ".") == 0)
638 flist->files[0]->flags |= FLAG_DIR_CREATED;
640 if (INFO_GTE(NAME, 1))
641 rprintf(FINFO, "created directory %s\n", dest_path);
644 /* Indicate that dest dir doesn't really exist. */
648 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
649 rsyserr(FERROR, errno, "change_dir#2 %s failed",
650 full_fname(dest_path));
651 exit_cleanup(RERR_FILESELECT);
657 /* Otherwise, we are writing a single file, possibly on top of an
658 * existing non-directory. Change to the item's parent directory
659 * (if it has a path component), return the basename of the
660 * destination file as the local name, and use mode 2. */
668 if (!change_dir(dest_path, CD_NORMAL)) {
669 rsyserr(FERROR, errno, "change_dir#3 %s failed",
670 full_fname(dest_path));
671 exit_cleanup(RERR_FILESELECT);
678 /* This function checks on our alternate-basis directories. If we're in
679 * dry-run mode and the destination dir does not yet exist, we'll try to
680 * tweak any dest-relative paths to make them work for a dry-run (the
681 * destination dir must be in curr_dir[] when this function is called).
682 * We also warn about any arg that is non-existent or not a directory. */
683 static void check_alt_basis_dirs(void)
686 char **dir_p, *slash = strrchr(curr_dir, '/');
688 for (dir_p = basis_dir; *dir_p; dir_p++) {
689 if (dry_run > 1 && **dir_p != '/') {
690 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
691 char *new = new_array(char, len);
693 out_of_memory("check_alt_basis_dirs");
694 if (slash && strncmp(*dir_p, "../", 3) == 0) {
695 /* We want to remove only one leading "../" prefix for
696 * the directory we couldn't create in dry-run mode:
697 * this ensures that any other ".." references get
698 * evaluated the same as they would for a live copy. */
700 pathjoin(new, len, curr_dir, *dir_p + 3);
703 pathjoin(new, len, curr_dir, *dir_p);
706 if (do_stat(*dir_p, &st) < 0) {
707 rprintf(FWARNING, "%s arg does not exist: %s\n",
708 dest_option, *dir_p);
709 } else if (!S_ISDIR(st.st_mode)) {
710 rprintf(FWARNING, "%s arg is not a dir: %s\n",
711 dest_option, *dir_p);
716 /* This is only called by the sender. */
717 static void read_final_goodbye(int f_in, int f_out)
721 char xname[MAXPATHLEN];
723 if (protocol_version < 29)
726 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type, xname, &xlen);
727 if (protocol_version >= 31 && i == NDX_DONE) {
729 write_ndx(f_out, NDX_DONE);
731 if (batch_gen_fd >= 0) {
732 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
733 read_del_stats(batch_gen_fd);
735 send_msg(MSG_DONE, "", 0, 0);
737 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type, xname, &xlen);
742 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
744 exit_cleanup(RERR_PROTOCOL);
748 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
750 struct file_list *flist;
753 if (DEBUG_GTE(SEND, 1)) {
754 rprintf(FINFO, "server_sender starting pid=%ld\n",
758 if (am_daemon && lp_write_only(module_id)) {
759 rprintf(FERROR, "ERROR: module is write only\n");
760 exit_cleanup(RERR_SYNTAX);
763 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
765 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
766 remove_source_files == 1 ? "source" : "sent");
767 exit_cleanup(RERR_SYNTAX);
771 if (!relative_paths) {
772 if (!change_dir(dir, CD_NORMAL)) {
773 rsyserr(FERROR, errno, "change_dir#3 %s failed",
775 exit_cleanup(RERR_FILESELECT);
781 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
787 flist = send_file_list(f_out,argc,argv);
788 if (!flist || flist->used == 0)
791 io_start_buffering_in(f_in);
793 send_files(f_in, f_out);
794 io_flush(FULL_FLUSH);
796 if (protocol_version >= 24)
797 read_final_goodbye(f_in, f_out);
798 io_flush(FULL_FLUSH);
803 static int do_recv(int f_in, int f_out, char *local_name)
809 /* The receiving side mustn't obey this, or an existing symlink that
810 * points to an identical file won't be replaced by the referent. */
811 copy_links = copy_dirlinks = copy_unsafe_links = 0;
813 #ifdef SUPPORT_HARD_LINKS
814 if (preserve_hard_links && !inc_recurse)
815 match_hard_links(first_flist);
818 if (fd_pair(error_pipe) < 0) {
819 rsyserr(FERROR, errno, "pipe failed in do_recv");
820 exit_cleanup(RERR_IPC);
824 int ret = make_path(backup_dir_buf, MKP_DROP_NAME); /* drops trailing slash */
826 exit_cleanup(RERR_SYNTAX);
828 rprintf(FINFO, "Created backup_dir %s\n", backup_dir_buf);
829 else if (INFO_GTE(BACKUP, 1))
830 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
833 io_flush(NORMAL_FLUSH);
835 if ((pid = do_fork()) == -1) {
836 rsyserr(FERROR, errno, "fork failed in do_recv");
837 exit_cleanup(RERR_IPC);
841 close(error_pipe[0]);
845 /* we can't let two processes write to the socket at one time */
846 io_end_multiplex_out();
848 /* set place to send errors */
849 set_msg_fd_out(error_pipe[1]);
850 io_start_multiplex_out(error_pipe[1]);
852 recv_files(f_in, local_name);
853 io_flush(FULL_FLUSH);
856 if (output_needs_newline) {
858 output_needs_newline = 0;
861 send_msg(MSG_DONE, "", 1, 0);
862 write_varlong(error_pipe[1], stats.total_read, 3);
863 io_flush(FULL_FLUSH);
865 /* Handle any keep-alive packets from the post-processing work
866 * that the generator does. */
867 if (protocol_version >= 29) {
868 kluge_around_eof = -1;
870 /* This should only get stopped via a USR2 signal. */
871 read_final_goodbye(f_in, f_out);
873 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
875 exit_cleanup(RERR_PROTOCOL);
878 /* Finally, we go to sleep until our parent kills us with a
879 * USR2 signal. We sleep for a short time, as on some OSes
880 * a signal won't interrupt a sleep! */
887 io_end_multiplex_in();
888 if (write_batch && !am_server)
891 close(error_pipe[1]);
895 io_start_buffering_out(f_out);
897 set_msg_fd_in(error_pipe[0]);
898 io_start_multiplex_in(error_pipe[0]);
900 #ifdef SUPPORT_HARD_LINKS
901 if (preserve_hard_links && inc_recurse) {
902 struct file_list *flist;
903 for (flist = first_flist; flist; flist = flist->next)
904 match_hard_links(flist);
908 generate_files(f_out, local_name);
911 io_flush(FULL_FLUSH);
912 if (protocol_version >= 24) {
913 /* send a final goodbye message */
914 write_ndx(f_out, NDX_DONE);
916 io_flush(FULL_FLUSH);
920 wait_process_with_flush(pid, &exit_code);
924 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
927 struct file_list *flist;
928 char *local_name = NULL;
931 if (filesfrom_fd >= 0 && !msgs2stderr) {
932 /* We can't mix messages with files-from data on the socket,
933 * so temporarily turn off info/debug messages. */
934 negate_output_levels();
939 if (DEBUG_GTE(RECV, 1)) {
940 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
941 argc, (long)getpid());
944 if (am_daemon && lp_read_only(module_id)) {
945 rprintf(FERROR,"ERROR: module is read only\n");
946 exit_cleanup(RERR_SYNTAX);
954 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
955 rsyserr(FERROR, errno, "change_dir#4 %s failed",
957 exit_cleanup(RERR_FILESELECT);
961 if (protocol_version >= 30)
962 io_start_multiplex_in(f_in);
964 io_start_buffering_in(f_in);
965 recv_filter_list(f_in);
967 if (filesfrom_fd >= 0) {
968 /* We need to send the files-from names to the sender at the
969 * same time that we receive the file-list from them, so we
970 * need the IO routines to automatically write out the names
971 * onto our f_out socket as we read the file-list. This
972 * avoids both deadlock and extra delays/buffers. */
973 io_set_filesfrom_fds(filesfrom_fd, f_out);
977 flist = recv_file_list(f_in);
979 rprintf(FERROR,"server_recv: recv_file_list error\n");
980 exit_cleanup(RERR_FILESELECT);
982 if (inc_recurse && file_total == 1)
983 recv_additional_file_list(f_in);
986 negate_output_levels();
989 local_name = get_local_name(flist,argv[0]);
991 /* Now that we know what our destination directory turned out to be,
992 * we can sanitize the --link-/copy-/compare-dest args correctly. */
993 if (sanitize_paths) {
995 for (dir_p = basis_dir; *dir_p; dir_p++)
996 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
998 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1000 check_alt_basis_dirs();
1002 if (daemon_filter_list.head) {
1004 filter_rule_list *elp = &daemon_filter_list;
1006 for (dir_p = basis_dir; *dir_p; dir_p++) {
1009 dir += module_dirlen;
1010 if (check_filter(elp, FLOG, dir, 1) < 0)
1011 goto options_rejected;
1013 if (partial_dir && *partial_dir == '/'
1014 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1017 "Your options have been rejected by the server.\n");
1018 exit_cleanup(RERR_SYNTAX);
1022 exit_code = do_recv(f_in, f_out, local_name);
1023 exit_cleanup(exit_code);
1027 int child_main(int argc, char *argv[])
1029 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1034 void start_server(int f_in, int f_out, int argc, char *argv[])
1036 set_nonblocking(f_in);
1037 set_nonblocking(f_out);
1039 io_set_sock_fds(f_in, f_out);
1040 setup_protocol(f_out, f_in);
1042 if (protocol_version >= 23)
1043 io_start_multiplex_out(f_out);
1046 keep_dirlinks = 0; /* Must be disabled on the sender. */
1047 if (need_messages_from_generator)
1048 io_start_multiplex_in(f_in);
1049 recv_filter_list(f_in);
1050 do_server_sender(f_in, f_out, argc, argv);
1052 do_server_recv(f_in, f_out, argc, argv);
1058 * This is called once the connection has been negotiated. It is used
1059 * for rsyncd, remote-shell, and local connections.
1061 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1063 struct file_list *flist = NULL;
1064 int exit_code = 0, exit_code2 = 0;
1065 char *local_name = NULL;
1067 cleanup_child_pid = pid;
1069 set_nonblocking(f_in);
1070 set_nonblocking(f_out);
1073 io_set_sock_fds(f_in, f_out);
1074 setup_protocol(f_out,f_in);
1076 /* We set our stderr file handle to blocking because ssh might have
1077 * set it to non-blocking. This can be particularly troublesome if
1078 * stderr is a clone of stdout, because ssh would have set our stdout
1079 * to non-blocking at the same time (which can easily cause us to lose
1080 * output from our print statements). This kluge shouldn't cause ssh
1081 * any problems for how we use it. Note also that we delayed setting
1082 * this until after the above protocol setup so that we know for sure
1083 * that ssh is done twiddling its file descriptors. */
1084 set_blocking(STDERR_FILENO);
1087 keep_dirlinks = 0; /* Must be disabled on the sender. */
1090 && (log_format_has(stdout_format, 'C')
1091 || log_format_has(logfile_format, 'C')))
1092 sender_keeps_checksum = 1;
1094 if (protocol_version >= 30)
1095 io_start_multiplex_out(f_out);
1097 io_start_buffering_out(f_out);
1098 if (!filesfrom_host)
1099 set_msg_fd_in(f_in);
1100 send_filter_list(f_out);
1102 filesfrom_fd = f_in;
1104 if (write_batch && !am_server)
1105 start_write_batch(f_out);
1106 flist = send_file_list(f_out, argc, argv);
1107 if (DEBUG_GTE(FLIST, 3))
1108 rprintf(FINFO,"file list sent\n");
1110 if (protocol_version >= 23)
1111 io_start_multiplex_in(f_in);
1113 io_flush(NORMAL_FLUSH);
1114 send_files(f_in, f_out);
1115 io_flush(FULL_FLUSH);
1117 if (protocol_version >= 24)
1118 read_final_goodbye(f_in, f_out);
1120 if (DEBUG_GTE(EXIT, 2))
1121 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1122 io_flush(FULL_FLUSH);
1123 wait_process_with_flush(pid, &exit_code);
1126 io_flush(FULL_FLUSH);
1127 exit_cleanup(exit_code);
1131 if (protocol_version >= 23)
1132 io_start_multiplex_in(f_in);
1133 if (need_messages_from_generator)
1134 io_start_multiplex_out(f_out);
1137 send_filter_list(read_batch ? -1 : f_out);
1139 if (filesfrom_fd >= 0) {
1140 io_set_filesfrom_fds(filesfrom_fd, f_out);
1144 if (write_batch && !am_server)
1145 start_write_batch(f_in);
1146 flist = recv_file_list(f_in);
1147 if (inc_recurse && file_total == 1)
1148 recv_additional_file_list(f_in);
1150 if (flist && flist->used > 0) {
1151 local_name = get_local_name(flist, argv[0]);
1153 check_alt_basis_dirs();
1155 exit_code2 = do_recv(f_in, f_out, local_name);
1162 if (DEBUG_GTE(RECV, 1))
1163 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1164 io_flush(FULL_FLUSH);
1165 wait_process_with_flush(pid, &exit_code);
1168 return MAX(exit_code, exit_code2);
1171 static int copy_argv(char *argv[])
1175 for (i = 0; argv[i]; i++) {
1176 if (!(argv[i] = strdup(argv[i]))) {
1177 rprintf (FERROR, "out of memory at %s(%d)\n",
1178 __FILE__, __LINE__);
1188 * Start a client for either type of remote connection. Work out
1189 * whether the arguments request a remote shell or rsyncd connection,
1190 * and call the appropriate connection function, then run_client.
1192 * Calls either start_socket_client (for sockets) or do_cmd and
1193 * client_run (for ssh).
1195 static int start_client(int argc, char *argv[])
1197 char *p, *shell_machine = NULL, *shell_user = NULL;
1204 /* Don't clobber argv[] so that ps(1) can still show the right
1206 if ((ret = copy_argv(argv)) != 0)
1209 if (!read_batch) { /* for read_batch, NO source is specified */
1210 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1211 if (path) { /* source is remote */
1218 if (argc == 1 || **argv == ':')
1219 argc = 0; /* no dest arg */
1220 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1222 "The source and destination cannot both be remote.\n");
1223 exit_cleanup(RERR_SYNTAX);
1225 remote_argc--; /* don't count dest */
1228 if (filesfrom_host && *filesfrom_host
1229 && strcmp(filesfrom_host, shell_machine) != 0) {
1231 "--files-from hostname is not the same as the transfer hostname\n");
1232 exit_cleanup(RERR_SYNTAX);
1236 daemon_over_rsh = shell_cmd ? 1 : -1;
1237 } else { /* source is local, check dest arg */
1242 remote_argv = argv + argc;
1244 static char *dotarg[1] = { "." };
1246 remote_argv = dotarg;
1250 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1251 if (path && filesfrom_host && *filesfrom_host
1252 && strcmp(filesfrom_host, shell_machine) != 0) {
1254 "--files-from hostname is not the same as the transfer hostname\n");
1255 exit_cleanup(RERR_SYNTAX);
1257 if (!path) { /* no hostspec found, so src & dest are local */
1259 if (filesfrom_host) {
1261 "--files-from cannot be remote when the transfer is local\n");
1262 exit_cleanup(RERR_SYNTAX);
1264 shell_machine = NULL;
1265 } else { /* hostspec was found, so dest is remote */
1268 daemon_over_rsh = shell_cmd ? 1 : -1;
1271 } else { /* read_batch */
1273 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1274 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1275 exit_cleanup(RERR_SYNTAX);
1277 remote_argv = argv += argc - 1;
1278 remote_argc = argc = 1;
1283 int dummy_port = rsync_port;
1285 /* For local source, extra source args must not have hostspec. */
1286 for (i = 1; i < argc; i++) {
1287 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1288 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1289 exit_cleanup(RERR_SYNTAX);
1294 int dummy_port = rsync_port;
1296 /* For remote source, any extra source args must have either
1297 * the same hostname or an empty hostname. */
1298 for (i = 1; i < remote_argc; i++) {
1299 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1301 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1302 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1303 exit_cleanup(RERR_SYNTAX);
1305 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1306 rprintf(FERROR, "All source args must come from the same machine.\n");
1307 exit_cleanup(RERR_SYNTAX);
1309 if (rsync_port != dummy_port) {
1310 if (!rsync_port || !dummy_port)
1311 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1313 rprintf(FERROR, "All source args must use the same port number.\n");
1314 exit_cleanup(RERR_SYNTAX);
1316 remote_argv[i] = arg;
1320 if (daemon_over_rsh < 0)
1321 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1323 if (password_file && !daemon_over_rsh) {
1324 rprintf(FERROR, "The --password-file option may only be "
1325 "used when accessing an rsync daemon.\n");
1326 exit_cleanup(RERR_SYNTAX);
1329 if (connect_timeout) {
1330 rprintf(FERROR, "The --contimeout option may only be "
1331 "used when connecting to an rsync daemon.\n");
1332 exit_cleanup(RERR_SYNTAX);
1335 if (shell_machine) {
1336 p = strrchr(shell_machine,'@');
1339 shell_user = shell_machine;
1340 shell_machine = p+1;
1344 if (DEBUG_GTE(CMD, 2)) {
1345 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1346 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1347 remote_argv ? NS(remote_argv[0]) : "");
1350 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1353 /* if we're running an rsync server on the remote host over a
1354 * remote shell command, we need to do the RSYNCD protocol first */
1355 if (daemon_over_rsh) {
1357 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1362 ret = client_run(f_in, f_out, pid, argc, argv);
1371 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1373 exit_cleanup(RERR_SIGNAL1);
1376 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1382 _exit(RERR_PARTIAL);
1386 RETSIGTYPE remember_children(UNUSED(int val))
1391 /* An empty waitpid() loop was put here by Tridge and we could never
1392 * get him to explain why he put it in, so rather than taking it
1393 * out we're instead saving the child exit statuses for later use.
1394 * The waitpid() loop presumably eliminates all possibility of leaving
1395 * zombie children, maybe that's why he did it. */
1396 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1397 /* save the child's exit status */
1398 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1399 if (pid_stat_table[cnt].pid == 0) {
1400 pid_stat_table[cnt].pid = pid;
1401 pid_stat_table[cnt].status = status;
1407 #ifndef HAVE_SIGACTION
1408 signal(SIGCHLD, remember_children);
1414 * This routine catches signals and tries to send them to gdb.
1416 * Because it's called from inside a signal handler it ought not to
1417 * use too many library routines.
1419 * @todo Perhaps use "screen -X" instead/as well, to help people
1420 * debugging without easy access to X. Perhaps use an environment
1421 * variable, or just call a script?
1423 * @todo The /proc/ magic probably only works on Linux (and
1424 * Solaris?) Can we be more portable?
1426 #ifdef MAINTAINER_MODE
1427 const char *get_panic_action(void)
1429 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1434 return "xterm -display :0 -T Panic -n Panic "
1435 "-e gdb /proc/%d/exe %d";
1440 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1442 * This signal handler is only installed if we were configured with
1443 * --enable-maintainer-mode. Perhaps it should always be on and we
1444 * should just look at the environment variable, but I'm a bit leery
1445 * of a signal sending us into a busy loop.
1447 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1452 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1453 getpid(), getpid());
1455 /* Unless we failed to execute gdb, we allow the process to
1456 * continue. I'm not sure if that's right. */
1457 ret = system(cmd_buf);
1464 int main(int argc,char *argv[])
1467 int orig_argc = argc;
1468 char **orig_argv = argv;
1469 #ifdef HAVE_SIGACTION
1470 # ifdef HAVE_SIGPROCMASK
1473 sigemptyset(&sigmask);
1475 sigact.sa_flags = SA_NOCLDSTOP;
1477 SIGACTMASK(SIGUSR1, sigusr1_handler);
1478 SIGACTMASK(SIGUSR2, sigusr2_handler);
1479 SIGACTMASK(SIGCHLD, remember_children);
1480 #ifdef MAINTAINER_MODE
1481 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1482 SIGACTMASK(SIGFPE, rsync_panic_handler);
1483 SIGACTMASK(SIGABRT, rsync_panic_handler);
1484 SIGACTMASK(SIGBUS, rsync_panic_handler);
1487 starttime = time(NULL);
1490 am_root = our_uid == 0;
1492 memset(&stats, 0, sizeof(stats));
1496 exit_cleanup(RERR_SYNTAX);
1499 /* we set a 0 umask so that correct file permissions can be
1501 orig_umask = umask(0);
1503 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1504 setlocale(LC_CTYPE, "");
1507 if (!parse_arguments(&argc, (const char ***) &argv)) {
1508 /* FIXME: We ought to call the same error-handling
1509 * code here, rather than relying on getopt. */
1511 exit_cleanup(RERR_SYNTAX);
1514 SIGACTMASK(SIGINT, sig_int);
1515 SIGACTMASK(SIGHUP, sig_int);
1516 SIGACTMASK(SIGTERM, sig_int);
1517 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1518 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1521 /* Ignore SIGPIPE; we consistently check error codes and will
1523 SIGACTION(SIGPIPE, SIG_IGN);
1525 SIGACTION(SIGXFSZ, SIG_IGN);
1528 /* Initialize change_dir() here because on some old systems getcwd
1529 * (implemented by forking "pwd" and reading its output) doesn't
1530 * work when there are other child processes. Also, on all systems
1531 * that implement getcwd that way "pwd" can't be found after chroot. */
1532 change_dir(NULL, CD_NORMAL);
1536 if ((write_batch || read_batch) && !am_server) {
1538 write_batch_shell_file(orig_argc, orig_argv, argc);
1540 if (read_batch && strcmp(batch_name, "-") == 0)
1541 batch_fd = STDIN_FILENO;
1543 batch_fd = do_open(batch_name,
1544 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1545 : O_RDONLY, S_IRUSR | S_IWUSR);
1548 rsyserr(FERROR, errno, "Batch file %s open error",
1549 full_fname(batch_name));
1550 exit_cleanup(RERR_FILEIO);
1553 read_stream_flags(batch_fd);
1555 write_stream_flags(batch_fd);
1557 if (write_batch < 0)
1564 } else if (am_daemon)
1565 return daemon_main();
1567 if (am_server && protect_args) {
1568 char buf[MAXPATHLEN];
1570 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1571 if (!parse_arguments(&argc, (const char ***) &argv)) {
1573 exit_cleanup(RERR_SYNTAX);
1579 exit_cleanup(RERR_SYNTAX);
1583 set_nonblocking(STDIN_FILENO);
1584 set_nonblocking(STDOUT_FILENO);
1586 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1587 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1590 ret = start_client(argc, argv);
1592 exit_cleanup(RERR_STARTCLIENT);