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
32 extern int io_timeout;
37 extern int inc_recurse;
38 extern int blocking_io;
39 extern int always_checksum;
40 extern int remove_source_files;
41 extern int output_needs_newline;
42 extern int need_messages_from_generator;
43 extern int kluge_around_eof;
44 extern int got_xfer_error;
45 extern int msgs2stderr;
48 extern int copy_links;
49 extern int copy_dirlinks;
50 extern int copy_unsafe_links;
51 extern int keep_dirlinks;
52 extern int preserve_hard_links;
53 extern int protocol_version;
54 extern int file_total;
57 extern int protect_args;
58 extern int relative_paths;
59 extern int sanitize_paths;
60 extern int curr_dir_depth;
61 extern int curr_dir_len;
63 extern int rsync_port;
64 extern int whole_file;
65 extern int read_batch;
66 extern int write_batch;
69 extern int sock_f_out;
70 extern int filesfrom_fd;
71 extern int connect_timeout;
72 extern int send_msgs_to_gen;
73 extern pid_t cleanup_child_pid;
74 extern size_t bwlimit_writemax;
75 extern unsigned int module_dirlen;
76 extern struct stats stats;
77 extern char *stdout_format;
78 extern char *logfile_format;
79 extern char *filesfrom_host;
80 extern char *partial_dir;
81 extern char *dest_option;
82 extern char *rsync_path;
83 extern char *shell_cmd;
84 extern char *batch_name;
85 extern char *password_file;
86 extern char *backup_dir;
87 extern char curr_dir[MAXPATHLEN];
88 extern char backup_dir_buf[MAXPATHLEN];
89 extern char *basis_dir[MAX_BASIS_DIRS+1];
90 extern struct file_list *first_flist;
91 extern filter_rule_list daemon_filter_list;
97 int daemon_over_rsh = 0;
98 mode_t orig_umask = 0;
99 int batch_gen_fd = -1;
100 int sender_keeps_checksum = 0;
102 /* There's probably never more than at most 2 outstanding child processes,
103 * but set it higher, just in case. */
104 #define MAXCHILDPROCS 7
106 #ifdef HAVE_SIGACTION
107 # ifdef HAVE_SIGPROCMASK
108 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
110 # define SIGACTMASK(n,h) SIGACTION(n,h)
112 static struct sigaction sigact;
118 } pid_stat_table[MAXCHILDPROCS];
120 static time_t starttime, endtime;
121 static int64 total_read, total_written;
123 static void show_malloc_stats(void);
125 /* Works like waitpid(), but if we already harvested the child pid in our
126 * remember_children(), we succeed instead of returning an error. */
127 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
132 waited_pid = waitpid(pid, status_ptr, flags);
133 } while (waited_pid == -1 && errno == EINTR);
135 if (waited_pid == -1 && errno == ECHILD) {
136 /* Status of requested child no longer available: check to
137 * see if it was processed by remember_children(). */
139 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
140 if (pid == pid_stat_table[cnt].pid) {
141 *status_ptr = pid_stat_table[cnt].status;
142 pid_stat_table[cnt].pid = 0;
151 /* Wait for a process to exit, calling io_flush while waiting. */
152 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
157 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
159 io_flush(FULL_FLUSH);
162 /* TODO: If the child exited on a signal, then log an
163 * appropriate error message. Perhaps we should also accept a
164 * message describing the purpose of the child. Also indicate
165 * this to the caller so that they know something went wrong. */
166 if (waited_pid < 0) {
167 rsyserr(FERROR, errno, "waitpid");
168 *exit_code_ptr = RERR_WAITCHILD;
169 } else if (!WIFEXITED(status)) {
171 if (WCOREDUMP(status))
172 *exit_code_ptr = RERR_CRASHED;
175 if (WIFSIGNALED(status))
176 *exit_code_ptr = RERR_TERMINATED;
178 *exit_code_ptr = RERR_WAITCHILD;
180 *exit_code_ptr = WEXITSTATUS(status);
183 void write_del_stats(int f)
186 write_int(f, NDX_DEL_STATS);
188 write_ndx(f, NDX_DEL_STATS);
189 write_varint(f, stats.deleted_files - stats.deleted_dirs
190 - stats.deleted_symlinks - stats.deleted_devices
191 - stats.deleted_specials);
192 write_varint(f, stats.deleted_dirs);
193 write_varint(f, stats.deleted_symlinks);
194 write_varint(f, stats.deleted_devices);
195 write_varint(f, stats.deleted_specials);
198 void read_del_stats(int f)
200 stats.deleted_files = read_varint(f);
201 stats.deleted_files += stats.deleted_dirs = read_varint(f);
202 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
203 stats.deleted_files += stats.deleted_devices = read_varint(f);
204 stats.deleted_files += stats.deleted_specials = read_varint(f);
207 /* This function gets called from all 3 processes. We want the client side
208 * to actually output the text, but the sender is the only process that has
209 * all the stats we need. So, if we're a client sender, we do the report.
210 * If we're a server sender, we write the stats on the supplied fd. If
211 * we're the client receiver we read the stats from the supplied fd and do
212 * the report. All processes might also generate a set of debug stats, if
213 * the verbose level is high enough (this is the only thing that the
214 * generator process and the server receiver ever do here). */
215 static void handle_stats(int f)
217 endtime = time(NULL);
219 /* Cache two stats because the read/write code can change it. */
220 total_read = stats.total_read;
221 total_written = stats.total_written;
223 if (INFO_GTE(STATS, 3)) {
224 /* These come out from every process */
233 if (f == -1 || !am_sender)
239 write_varlong30(f, total_read, 3);
240 write_varlong30(f, total_written, 3);
241 write_varlong30(f, stats.total_size, 3);
242 if (protocol_version >= 29) {
243 write_varlong30(f, stats.flist_buildtime, 3);
244 write_varlong30(f, stats.flist_xfertime, 3);
250 /* this is the client */
252 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
254 else if (!am_sender) {
255 /* Read the first two in opposite order because the meaning of
256 * read/write swaps when switching from sender to receiver. */
257 total_written = read_varlong30(f, 3);
258 total_read = read_varlong30(f, 3);
259 stats.total_size = read_varlong30(f, 3);
260 if (protocol_version >= 29) {
261 stats.flist_buildtime = read_varlong30(f, 3);
262 stats.flist_xfertime = read_varlong30(f, 3);
264 } else if (write_batch) {
265 /* The --read-batch process is going to be a client
266 * receiver, so we need to give it the stats. */
267 write_varlong30(batch_fd, total_read, 3);
268 write_varlong30(batch_fd, total_written, 3);
269 write_varlong30(batch_fd, stats.total_size, 3);
270 if (protocol_version >= 29) {
271 write_varlong30(batch_fd, stats.flist_buildtime, 3);
272 write_varlong30(batch_fd, stats.flist_xfertime, 3);
277 static void output_itemized_counts(const char *prefix, int *counts)
279 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
280 char buf[1024], *pre = " (";
282 int total = counts[0];
284 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
285 for (j = 0; j < 5; j++) {
287 len += snprintf(buf+len, sizeof buf - len - 2,
289 pre, labels[j], comma_num(counts[j]));
296 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
299 static void output_summary(void)
301 if (INFO_GTE(STATS, 2)) {
302 rprintf(FCLIENT, "\n");
303 output_itemized_counts("Number of files", &stats.num_files);
304 if (protocol_version >= 29)
305 output_itemized_counts("Number of created files", &stats.created_files);
306 if (protocol_version >= 31)
307 output_itemized_counts("Number of deleted files", &stats.deleted_files);
308 rprintf(FINFO,"Number of regular files transferred: %s\n",
309 comma_num(stats.xferred_files));
310 rprintf(FINFO,"Total file size: %s bytes\n",
311 human_num(stats.total_size));
312 rprintf(FINFO,"Total transferred file size: %s bytes\n",
313 human_num(stats.total_transferred_size));
314 rprintf(FINFO,"Literal data: %s bytes\n",
315 human_num(stats.literal_data));
316 rprintf(FINFO,"Matched data: %s bytes\n",
317 human_num(stats.matched_data));
318 rprintf(FINFO,"File list size: %s\n",
319 human_num(stats.flist_size));
320 if (stats.flist_buildtime) {
322 "File list generation time: %s seconds\n",
323 comma_dnum((double)stats.flist_buildtime / 1000, 3));
325 "File list transfer time: %s seconds\n",
326 comma_dnum((double)stats.flist_xfertime / 1000, 3));
328 rprintf(FINFO,"Total bytes sent: %s\n",
329 human_num(total_written));
330 rprintf(FINFO,"Total bytes received: %s\n",
331 human_num(total_read));
334 if (INFO_GTE(STATS, 1)) {
335 rprintf(FCLIENT, "\n");
337 "sent %s bytes received %s bytes %s bytes/sec\n",
338 human_num(total_written), human_num(total_read),
339 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
340 rprintf(FINFO, "total size is %s speedup is %s%s\n",
341 human_num(stats.total_size),
342 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
343 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
352 * If our C library can get malloc statistics, then show them to FINFO
354 static void show_malloc_stats(void)
361 rprintf(FCLIENT, "\n");
362 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
363 getpid(), am_server ? "server " : "",
364 am_daemon ? "daemon " : "", who_am_i());
365 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
367 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
369 rprintf(FINFO, " smblks: %10ld\n",
371 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
373 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
375 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
376 (long)mi.arena + mi.hblkhd);
377 rprintf(FINFO, " usmblks: %10ld\n",
379 rprintf(FINFO, " fsmblks: %10ld\n",
381 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
383 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
385 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
387 #endif /* HAVE_MALLINFO */
391 /* Start the remote shell. cmd may be NULL to use the default. */
392 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
393 int *f_in_p, int *f_out_p)
396 char *args[MAX_ARGS];
400 if (!read_batch && !local_server) {
401 char *t, *f, in_quote = '\0';
402 char *rsh_env = getenv(RSYNC_RSH_ENV);
407 cmd = strdup(cmd); /* MEMORY LEAK */
411 for (t = f = cmd; *f; f++) {
414 /* Comparison leaves rooms for server_options(). */
415 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
418 while (*f != ' ' || in_quote) {
422 "Missing trailing-%c in remote-shell command.\n",
424 exit_cleanup(RERR_SYNTAX);
429 if (*f == '\'' || *f == '"') {
434 if (*f == in_quote && *++f != in_quote) {
444 /* check to see if we've already been given '-l user' in
445 * the remote-shell command */
446 for (i = 0; i < argc-1; i++) {
447 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
452 /* remsh (on HPUX) takes the arguments the other way around */
453 args[argc++] = machine;
454 if (user && !(daemon_over_rsh && dash_l_set)) {
459 if (user && !(daemon_over_rsh && dash_l_set)) {
463 args[argc++] = machine;
466 args[argc++] = rsync_path;
468 if (blocking_io < 0) {
470 if ((cp = strrchr(cmd, '/')) != NULL)
474 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
478 server_options(args,&argc);
480 if (argc >= MAX_ARGS - 2)
486 if (!daemon_over_rsh) {
487 while (remote_argc > 0) {
488 if (argc >= MAX_ARGS - 1) {
490 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
491 exit_cleanup(RERR_SYNTAX);
493 args[argc++] = *remote_argv++;
500 if (DEBUG_GTE(CMD, 2)) {
501 for (i = 0; i < argc; i++)
502 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
503 rprintf(FCLIENT, "\n");
507 int from_gen_pipe[2];
508 set_allow_inc_recurse();
509 if (fd_pair(from_gen_pipe) < 0) {
510 rsyserr(FERROR, errno, "pipe");
511 exit_cleanup(RERR_IPC);
513 batch_gen_fd = from_gen_pipe[0];
514 *f_out_p = from_gen_pipe[1];
516 pid = (pid_t)-1; /* no child pid */
520 } else if (local_server) {
521 /* If the user didn't request --[no-]whole-file, force
522 * it on, but only if we're not batch processing. */
523 if (whole_file < 0 && !write_batch)
525 set_allow_inc_recurse();
526 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
531 pid = piped_child(args, f_in_p, f_out_p);
535 if (protect_args && !daemon_over_rsh)
536 send_protected_args(*f_out_p, args);
542 out_of_memory("do_cmd");
543 return 0; /* not reached */
546 /* The receiving side operates in one of two modes:
548 * 1. it receives any number of files into a destination directory,
549 * placing them according to their names in the file-list.
551 * 2. it receives a single file and saves it using the name in the
552 * destination path instead of its file-list name. This requires a
553 * "local name" for writing out the destination file.
555 * So, our task is to figure out what mode/local-name we need.
556 * For mode 1, we change into the destination directory and return NULL.
557 * For mode 2, we change into the directory containing the destination
558 * file (if we aren't already there) and return the local-name. */
559 static char *get_local_name(struct file_list *flist, char *dest_path)
565 if (DEBUG_GTE(RECV, 1)) {
566 rprintf(FINFO, "get_local_name count=%d %s\n",
567 file_total, NS(dest_path));
570 if (!dest_path || list_only)
573 if (daemon_filter_list.head) {
574 char *slash = strrchr(dest_path, '/');
575 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
579 if ((*dest_path != '.' || dest_path[1] != '\0')
580 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
581 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
582 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
584 exit_cleanup(RERR_FILESELECT);
590 /* See what currently exists at the destination. */
591 if ((statret = do_stat(dest_path, &st)) == 0) {
592 /* If the destination is a dir, enter it and use mode 1. */
593 if (S_ISDIR(st.st_mode)) {
594 if (!change_dir(dest_path, CD_NORMAL)) {
595 rsyserr(FERROR, errno, "change_dir#1 %s failed",
596 full_fname(dest_path));
597 exit_cleanup(RERR_FILESELECT);
601 if (file_total > 1) {
603 "ERROR: destination must be a directory when"
604 " copying more than 1 file\n");
605 exit_cleanup(RERR_FILESELECT);
607 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
609 "ERROR: cannot overwrite non-directory"
610 " with a directory\n");
611 exit_cleanup(RERR_FILESELECT);
613 } else if (errno != ENOENT) {
614 /* If we don't know what's at the destination, fail. */
615 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
616 full_fname(dest_path));
617 exit_cleanup(RERR_FILESELECT);
620 cp = strrchr(dest_path, '/');
622 /* If we need a destination directory because the transfer is not
623 * of a single non-directory or the user has requested one via a
624 * destination path ending in a slash, create one and use mode 1. */
625 if (file_total > 1 || (cp && !cp[1])) {
626 /* Lop off the final slash (if any). */
632 "ERROR: destination path is not a directory\n");
633 exit_cleanup(RERR_SYNTAX);
636 if (mkdir_defmode(dest_path) != 0) {
637 rsyserr(FERROR, errno, "mkdir %s failed",
638 full_fname(dest_path));
639 exit_cleanup(RERR_FILEIO);
642 if (flist->high >= flist->low
643 && strcmp(flist->files[flist->low]->basename, ".") == 0)
644 flist->files[0]->flags |= FLAG_DIR_CREATED;
646 if (INFO_GTE(NAME, 1))
647 rprintf(FINFO, "created directory %s\n", dest_path);
650 /* Indicate that dest dir doesn't really exist. */
654 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
655 rsyserr(FERROR, errno, "change_dir#2 %s failed",
656 full_fname(dest_path));
657 exit_cleanup(RERR_FILESELECT);
663 /* Otherwise, we are writing a single file, possibly on top of an
664 * existing non-directory. Change to the item's parent directory
665 * (if it has a path component), return the basename of the
666 * destination file as the local name, and use mode 2. */
674 if (!change_dir(dest_path, CD_NORMAL)) {
675 rsyserr(FERROR, errno, "change_dir#3 %s failed",
676 full_fname(dest_path));
677 exit_cleanup(RERR_FILESELECT);
684 /* This function checks on our alternate-basis directories. If we're in
685 * dry-run mode and the destination dir does not yet exist, we'll try to
686 * tweak any dest-relative paths to make them work for a dry-run (the
687 * destination dir must be in curr_dir[] when this function is called).
688 * We also warn about any arg that is non-existent or not a directory. */
689 static void check_alt_basis_dirs(void)
692 char **dir_p, *slash = strrchr(curr_dir, '/');
694 for (dir_p = basis_dir; *dir_p; dir_p++) {
695 if (dry_run > 1 && **dir_p != '/') {
696 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
697 char *new = new_array(char, len);
699 out_of_memory("check_alt_basis_dirs");
700 if (slash && strncmp(*dir_p, "../", 3) == 0) {
701 /* We want to remove only one leading "../" prefix for
702 * the directory we couldn't create in dry-run mode:
703 * this ensures that any other ".." references get
704 * evaluated the same as they would for a live copy. */
706 pathjoin(new, len, curr_dir, *dir_p + 3);
709 pathjoin(new, len, curr_dir, *dir_p);
712 if (do_stat(*dir_p, &st) < 0) {
713 rprintf(FWARNING, "%s arg does not exist: %s\n",
714 dest_option, *dir_p);
715 } else if (!S_ISDIR(st.st_mode)) {
716 rprintf(FWARNING, "%s arg is not a dir: %s\n",
717 dest_option, *dir_p);
722 /* This is only called by the sender. */
723 static void read_final_goodbye(int f_in, int f_out)
727 char xname[MAXPATHLEN];
729 if (protocol_version < 29)
732 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
733 if (protocol_version >= 31 && i == NDX_DONE) {
735 write_ndx(f_out, NDX_DONE);
737 if (batch_gen_fd >= 0) {
738 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
739 read_del_stats(batch_gen_fd);
741 write_int(f_out, NDX_DONE);
743 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
748 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
750 exit_cleanup(RERR_PROTOCOL);
754 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
756 struct file_list *flist;
759 if (DEBUG_GTE(SEND, 1)) {
760 rprintf(FINFO, "server_sender starting pid=%ld\n",
764 if (am_daemon && lp_write_only(module_id)) {
765 rprintf(FERROR, "ERROR: module is write only\n");
766 exit_cleanup(RERR_SYNTAX);
769 if (am_daemon && read_only && remove_source_files) {
771 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
772 remove_source_files == 1 ? "source" : "sent");
773 exit_cleanup(RERR_SYNTAX);
777 if (!relative_paths) {
778 if (!change_dir(dir, CD_NORMAL)) {
779 rsyserr(FERROR, errno, "change_dir#3 %s failed",
781 exit_cleanup(RERR_FILESELECT);
787 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
793 flist = send_file_list(f_out,argc,argv);
794 if (!flist || flist->used == 0)
797 io_start_buffering_in(f_in);
799 send_files(f_in, f_out);
800 io_flush(FULL_FLUSH);
802 if (protocol_version >= 24)
803 read_final_goodbye(f_in, f_out);
804 io_flush(FULL_FLUSH);
809 static int do_recv(int f_in, int f_out, char *local_name)
815 /* The receiving side mustn't obey this, or an existing symlink that
816 * points to an identical file won't be replaced by the referent. */
817 copy_links = copy_dirlinks = copy_unsafe_links = 0;
819 #ifdef SUPPORT_HARD_LINKS
820 if (preserve_hard_links && !inc_recurse)
821 match_hard_links(first_flist);
824 if (fd_pair(error_pipe) < 0) {
825 rsyserr(FERROR, errno, "pipe failed in do_recv");
826 exit_cleanup(RERR_IPC);
830 int ret = make_path(backup_dir_buf, MKP_DROP_NAME); /* drops trailing slash */
832 exit_cleanup(RERR_SYNTAX);
834 rprintf(FINFO, "Created backup_dir %s\n", backup_dir_buf);
835 else if (INFO_GTE(BACKUP, 1))
836 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
839 io_flush(FULL_FLUSH);
841 if ((pid = do_fork()) == -1) {
842 rsyserr(FERROR, errno, "fork failed in do_recv");
843 exit_cleanup(RERR_IPC);
847 send_msgs_to_gen = am_server;
849 close(error_pipe[0]);
851 /* We can't let two processes write to the socket at one time. */
852 io_end_multiplex_out(MPLX_SWITCHING);
856 f_out = error_pipe[1];
858 bwlimit_writemax = 0; /* receiver doesn't need to do this */
861 io_start_buffering_in(f_in);
862 io_start_multiplex_out(f_out);
864 recv_files(f_in, f_out, local_name);
865 io_flush(FULL_FLUSH);
868 if (output_needs_newline) {
870 output_needs_newline = 0;
873 write_int(f_out, NDX_DONE);
874 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
875 io_flush(FULL_FLUSH);
877 /* Handle any keep-alive packets from the post-processing work
878 * that the generator does. */
879 if (protocol_version >= 29) {
880 kluge_around_eof = -1;
882 /* This should only get stopped via a USR2 signal. */
883 read_final_goodbye(f_in, f_out);
885 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
887 exit_cleanup(RERR_PROTOCOL);
890 /* Finally, we go to sleep until our parent kills us with a
891 * USR2 signal. We sleep for a short time, as on some OSes
892 * a signal won't interrupt a sleep! */
899 io_end_multiplex_in(MPLX_SWITCHING);
900 if (write_batch && !am_server)
903 close(error_pipe[1]);
907 f_in = error_pipe[0];
909 io_start_buffering_out(f_out);
910 io_start_multiplex_in(f_in);
912 #ifdef SUPPORT_HARD_LINKS
913 if (preserve_hard_links && inc_recurse) {
914 struct file_list *flist;
915 for (flist = first_flist; flist; flist = flist->next)
916 match_hard_links(flist);
920 generate_files(f_out, local_name);
923 io_flush(FULL_FLUSH);
924 if (protocol_version >= 24) {
925 /* send a final goodbye message */
926 write_ndx(f_out, NDX_DONE);
928 io_flush(FULL_FLUSH);
931 wait_process_with_flush(pid, &exit_code);
935 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
938 struct file_list *flist;
939 char *local_name = NULL;
942 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
943 /* We can't mix messages with files-from data on the socket,
944 * so temporarily turn off info/debug messages. */
945 negate_output_levels();
950 if (DEBUG_GTE(RECV, 1)) {
951 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
952 argc, (long)getpid());
955 if (am_daemon && read_only) {
956 rprintf(FERROR,"ERROR: module is read only\n");
957 exit_cleanup(RERR_SYNTAX);
965 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
966 rsyserr(FERROR, errno, "change_dir#4 %s failed",
968 exit_cleanup(RERR_FILESELECT);
972 if (protocol_version >= 30)
973 io_start_multiplex_in(f_in);
975 io_start_buffering_in(f_in);
976 recv_filter_list(f_in);
978 if (filesfrom_fd >= 0) {
979 /* We need to send the files-from names to the sender at the
980 * same time that we receive the file-list from them, so we
981 * need the IO routines to automatically write out the names
982 * onto our f_out socket as we read the file-list. This
983 * avoids both deadlock and extra delays/buffers. */
984 start_filesfrom_forwarding(filesfrom_fd);
988 flist = recv_file_list(f_in);
990 rprintf(FERROR,"server_recv: recv_file_list error\n");
991 exit_cleanup(RERR_FILESELECT);
993 if (inc_recurse && file_total == 1)
994 recv_additional_file_list(f_in);
997 negate_output_levels();
1000 local_name = get_local_name(flist,argv[0]);
1002 /* Now that we know what our destination directory turned out to be,
1003 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1004 if (sanitize_paths) {
1006 for (dir_p = basis_dir; *dir_p; dir_p++)
1007 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1009 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1011 check_alt_basis_dirs();
1013 if (daemon_filter_list.head) {
1015 filter_rule_list *elp = &daemon_filter_list;
1017 for (dir_p = basis_dir; *dir_p; dir_p++) {
1020 dir += module_dirlen;
1021 if (check_filter(elp, FLOG, dir, 1) < 0)
1022 goto options_rejected;
1024 if (partial_dir && *partial_dir == '/'
1025 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1028 "Your options have been rejected by the server.\n");
1029 exit_cleanup(RERR_SYNTAX);
1033 exit_code = do_recv(f_in, f_out, local_name);
1034 exit_cleanup(exit_code);
1038 int child_main(int argc, char *argv[])
1040 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1045 void start_server(int f_in, int f_out, int argc, char *argv[])
1047 set_nonblocking(f_in);
1048 set_nonblocking(f_out);
1050 io_set_sock_fds(f_in, f_out);
1051 setup_protocol(f_out, f_in);
1053 if (protocol_version >= 23)
1054 io_start_multiplex_out(f_out);
1055 if (am_daemon && io_timeout && protocol_version >= 31)
1056 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1059 keep_dirlinks = 0; /* Must be disabled on the sender. */
1060 if (need_messages_from_generator)
1061 io_start_multiplex_in(f_in);
1063 io_start_buffering_in(f_in);
1064 recv_filter_list(f_in);
1065 do_server_sender(f_in, f_out, argc, argv);
1067 do_server_recv(f_in, f_out, argc, argv);
1071 /* This is called once the connection has been negotiated. It is used
1072 * for rsyncd, remote-shell, and local connections. */
1073 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1075 struct file_list *flist = NULL;
1076 int exit_code = 0, exit_code2 = 0;
1077 char *local_name = NULL;
1079 cleanup_child_pid = pid;
1081 set_nonblocking(f_in);
1082 set_nonblocking(f_out);
1085 io_set_sock_fds(f_in, f_out);
1086 setup_protocol(f_out,f_in);
1088 /* We set our stderr file handle to blocking because ssh might have
1089 * set it to non-blocking. This can be particularly troublesome if
1090 * stderr is a clone of stdout, because ssh would have set our stdout
1091 * to non-blocking at the same time (which can easily cause us to lose
1092 * output from our print statements). This kluge shouldn't cause ssh
1093 * any problems for how we use it. Note also that we delayed setting
1094 * this until after the above protocol setup so that we know for sure
1095 * that ssh is done twiddling its file descriptors. */
1096 set_blocking(STDERR_FILENO);
1099 keep_dirlinks = 0; /* Must be disabled on the sender. */
1102 && (log_format_has(stdout_format, 'C')
1103 || log_format_has(logfile_format, 'C')))
1104 sender_keeps_checksum = 1;
1106 if (protocol_version >= 30)
1107 io_start_multiplex_out(f_out);
1109 io_start_buffering_out(f_out);
1110 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1111 io_start_multiplex_in(f_in);
1113 io_start_buffering_in(f_in);
1114 send_filter_list(f_out);
1116 filesfrom_fd = f_in;
1118 if (write_batch && !am_server)
1119 start_write_batch(f_out);
1120 flist = send_file_list(f_out, argc, argv);
1121 if (DEBUG_GTE(FLIST, 3))
1122 rprintf(FINFO,"file list sent\n");
1124 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1125 io_start_multiplex_in(f_in);
1127 io_flush(NORMAL_FLUSH);
1128 send_files(f_in, f_out);
1129 io_flush(FULL_FLUSH);
1131 if (protocol_version >= 24)
1132 read_final_goodbye(f_in, f_out);
1134 if (DEBUG_GTE(EXIT, 2))
1135 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1136 io_flush(FULL_FLUSH);
1137 wait_process_with_flush(pid, &exit_code);
1140 io_flush(FULL_FLUSH);
1141 exit_cleanup(exit_code);
1145 if (protocol_version >= 23)
1146 io_start_multiplex_in(f_in);
1147 if (need_messages_from_generator)
1148 io_start_multiplex_out(f_out);
1150 io_start_buffering_out(f_out);
1153 send_filter_list(read_batch ? -1 : f_out);
1155 if (filesfrom_fd >= 0) {
1156 start_filesfrom_forwarding(filesfrom_fd);
1160 if (write_batch && !am_server)
1161 start_write_batch(f_in);
1162 flist = recv_file_list(f_in);
1163 if (inc_recurse && file_total == 1)
1164 recv_additional_file_list(f_in);
1166 if (flist && flist->used > 0) {
1167 local_name = get_local_name(flist, argv[0]);
1169 check_alt_basis_dirs();
1171 exit_code2 = do_recv(f_in, f_out, local_name);
1178 if (DEBUG_GTE(RECV, 1))
1179 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1180 io_flush(FULL_FLUSH);
1181 wait_process_with_flush(pid, &exit_code);
1184 return MAX(exit_code, exit_code2);
1187 static int copy_argv(char *argv[])
1191 for (i = 0; argv[i]; i++) {
1192 if (!(argv[i] = strdup(argv[i]))) {
1193 rprintf (FERROR, "out of memory at %s(%d)\n",
1194 __FILE__, __LINE__);
1203 /* Start a client for either type of remote connection. Work out
1204 * whether the arguments request a remote shell or rsyncd connection,
1205 * and call the appropriate connection function, then run_client.
1207 * Calls either start_socket_client (for sockets) or do_cmd and
1208 * client_run (for ssh). */
1209 static int start_client(int argc, char *argv[])
1211 char *p, *shell_machine = NULL, *shell_user = NULL;
1218 /* Don't clobber argv[] so that ps(1) can still show the right
1220 if ((ret = copy_argv(argv)) != 0)
1223 if (!read_batch) { /* for read_batch, NO source is specified */
1224 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1225 if (path) { /* source is remote */
1232 if (argc == 1 || **argv == ':')
1233 argc = 0; /* no dest arg */
1234 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1236 "The source and destination cannot both be remote.\n");
1237 exit_cleanup(RERR_SYNTAX);
1239 remote_argc--; /* don't count dest */
1242 if (filesfrom_host && *filesfrom_host
1243 && strcmp(filesfrom_host, shell_machine) != 0) {
1245 "--files-from hostname is not the same as the transfer hostname\n");
1246 exit_cleanup(RERR_SYNTAX);
1250 daemon_over_rsh = shell_cmd ? 1 : -1;
1251 } else { /* source is local, check dest arg */
1256 remote_argv = argv + argc;
1258 static char *dotarg[1] = { "." };
1260 remote_argv = dotarg;
1264 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1265 if (path && filesfrom_host && *filesfrom_host
1266 && strcmp(filesfrom_host, shell_machine) != 0) {
1268 "--files-from hostname is not the same as the transfer hostname\n");
1269 exit_cleanup(RERR_SYNTAX);
1271 if (!path) { /* no hostspec found, so src & dest are local */
1273 if (filesfrom_host) {
1275 "--files-from cannot be remote when the transfer is local\n");
1276 exit_cleanup(RERR_SYNTAX);
1278 shell_machine = NULL;
1279 } else { /* hostspec was found, so dest is remote */
1282 daemon_over_rsh = shell_cmd ? 1 : -1;
1285 } else { /* read_batch */
1287 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1288 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1289 exit_cleanup(RERR_SYNTAX);
1291 remote_argv = argv += argc - 1;
1292 remote_argc = argc = 1;
1297 int dummy_port = rsync_port;
1299 /* For local source, extra source args must not have hostspec. */
1300 for (i = 1; i < argc; i++) {
1301 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1302 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1303 exit_cleanup(RERR_SYNTAX);
1308 int dummy_port = rsync_port;
1310 /* For remote source, any extra source args must have either
1311 * the same hostname or an empty hostname. */
1312 for (i = 1; i < remote_argc; i++) {
1313 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1315 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1316 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1317 exit_cleanup(RERR_SYNTAX);
1319 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1320 rprintf(FERROR, "All source args must come from the same machine.\n");
1321 exit_cleanup(RERR_SYNTAX);
1323 if (rsync_port != dummy_port) {
1324 if (!rsync_port || !dummy_port)
1325 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1327 rprintf(FERROR, "All source args must use the same port number.\n");
1328 exit_cleanup(RERR_SYNTAX);
1330 remote_argv[i] = arg;
1334 if (daemon_over_rsh < 0)
1335 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1337 if (password_file && !daemon_over_rsh) {
1338 rprintf(FERROR, "The --password-file option may only be "
1339 "used when accessing an rsync daemon.\n");
1340 exit_cleanup(RERR_SYNTAX);
1343 if (connect_timeout) {
1344 rprintf(FERROR, "The --contimeout option may only be "
1345 "used when connecting to an rsync daemon.\n");
1346 exit_cleanup(RERR_SYNTAX);
1349 if (shell_machine) {
1350 p = strrchr(shell_machine,'@');
1353 shell_user = shell_machine;
1354 shell_machine = p+1;
1358 if (DEBUG_GTE(CMD, 2)) {
1359 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1360 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1361 remote_argv ? NS(remote_argv[0]) : "");
1364 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1367 /* if we're running an rsync server on the remote host over a
1368 * remote shell command, we need to do the RSYNCD protocol first */
1369 if (daemon_over_rsh) {
1371 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1376 ret = client_run(f_in, f_out, pid, argc, argv);
1385 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1387 exit_cleanup(RERR_SIGNAL1);
1390 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1396 _exit(RERR_PARTIAL);
1400 RETSIGTYPE remember_children(UNUSED(int val))
1405 /* An empty waitpid() loop was put here by Tridge and we could never
1406 * get him to explain why he put it in, so rather than taking it
1407 * out we're instead saving the child exit statuses for later use.
1408 * The waitpid() loop presumably eliminates all possibility of leaving
1409 * zombie children, maybe that's why he did it. */
1410 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1411 /* save the child's exit status */
1412 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1413 if (pid_stat_table[cnt].pid == 0) {
1414 pid_stat_table[cnt].pid = pid;
1415 pid_stat_table[cnt].status = status;
1421 #ifndef HAVE_SIGACTION
1422 signal(SIGCHLD, remember_children);
1428 * This routine catches signals and tries to send them to gdb.
1430 * Because it's called from inside a signal handler it ought not to
1431 * use too many library routines.
1433 * @todo Perhaps use "screen -X" instead/as well, to help people
1434 * debugging without easy access to X. Perhaps use an environment
1435 * variable, or just call a script?
1437 * @todo The /proc/ magic probably only works on Linux (and
1438 * Solaris?) Can we be more portable?
1440 #ifdef MAINTAINER_MODE
1441 const char *get_panic_action(void)
1443 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1448 return "xterm -display :0 -T Panic -n Panic "
1449 "-e gdb /proc/%d/exe %d";
1454 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1456 * This signal handler is only installed if we were configured with
1457 * --enable-maintainer-mode. Perhaps it should always be on and we
1458 * should just look at the environment variable, but I'm a bit leery
1459 * of a signal sending us into a busy loop.
1461 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1466 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1467 getpid(), getpid());
1469 /* Unless we failed to execute gdb, we allow the process to
1470 * continue. I'm not sure if that's right. */
1471 ret = system(cmd_buf);
1478 int main(int argc,char *argv[])
1481 int orig_argc = argc;
1482 char **orig_argv = argv;
1483 #ifdef HAVE_SIGACTION
1484 # ifdef HAVE_SIGPROCMASK
1487 sigemptyset(&sigmask);
1489 sigact.sa_flags = SA_NOCLDSTOP;
1491 SIGACTMASK(SIGUSR1, sigusr1_handler);
1492 SIGACTMASK(SIGUSR2, sigusr2_handler);
1493 SIGACTMASK(SIGCHLD, remember_children);
1494 #ifdef MAINTAINER_MODE
1495 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1496 SIGACTMASK(SIGFPE, rsync_panic_handler);
1497 SIGACTMASK(SIGABRT, rsync_panic_handler);
1498 SIGACTMASK(SIGBUS, rsync_panic_handler);
1501 starttime = time(NULL);
1504 am_root = our_uid == 0;
1506 memset(&stats, 0, sizeof(stats));
1510 exit_cleanup(RERR_SYNTAX);
1513 /* we set a 0 umask so that correct file permissions can be
1515 orig_umask = umask(0);
1517 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1518 setlocale(LC_CTYPE, "");
1521 if (!parse_arguments(&argc, (const char ***) &argv)) {
1522 /* FIXME: We ought to call the same error-handling
1523 * code here, rather than relying on getopt. */
1525 exit_cleanup(RERR_SYNTAX);
1528 SIGACTMASK(SIGINT, sig_int);
1529 SIGACTMASK(SIGHUP, sig_int);
1530 SIGACTMASK(SIGTERM, sig_int);
1531 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1532 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1535 /* Ignore SIGPIPE; we consistently check error codes and will
1537 SIGACTION(SIGPIPE, SIG_IGN);
1539 SIGACTION(SIGXFSZ, SIG_IGN);
1542 /* Initialize change_dir() here because on some old systems getcwd
1543 * (implemented by forking "pwd" and reading its output) doesn't
1544 * work when there are other child processes. Also, on all systems
1545 * that implement getcwd that way "pwd" can't be found after chroot. */
1546 change_dir(NULL, CD_NORMAL);
1550 if ((write_batch || read_batch) && !am_server) {
1552 write_batch_shell_file(orig_argc, orig_argv, argc);
1554 if (read_batch && strcmp(batch_name, "-") == 0)
1555 batch_fd = STDIN_FILENO;
1557 batch_fd = do_open(batch_name,
1558 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1559 : O_RDONLY, S_IRUSR | S_IWUSR);
1562 rsyserr(FERROR, errno, "Batch file %s open error",
1563 full_fname(batch_name));
1564 exit_cleanup(RERR_FILEIO);
1567 read_stream_flags(batch_fd);
1569 write_stream_flags(batch_fd);
1571 if (write_batch < 0)
1578 } else if (am_daemon)
1579 return daemon_main();
1581 if (am_server && protect_args) {
1582 char buf[MAXPATHLEN];
1584 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1585 if (!parse_arguments(&argc, (const char ***) &argv)) {
1587 exit_cleanup(RERR_SYNTAX);
1593 exit_cleanup(RERR_SYNTAX);
1597 set_nonblocking(STDIN_FILENO);
1598 set_nonblocking(STDOUT_FILENO);
1600 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1601 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1604 ret = start_client(argc, argv);
1606 exit_cleanup(RERR_STARTCLIENT);