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;
47 extern int copy_links;
48 extern int copy_dirlinks;
49 extern int copy_unsafe_links;
50 extern int keep_dirlinks;
51 extern int preserve_hard_links;
52 extern int protocol_version;
53 extern int file_total;
56 extern int protect_args;
57 extern int relative_paths;
58 extern int sanitize_paths;
59 extern int curr_dir_depth;
60 extern int curr_dir_len;
62 extern int rsync_port;
63 extern int whole_file;
64 extern int read_batch;
65 extern int write_batch;
68 extern int sock_f_out;
69 extern int filesfrom_fd;
70 extern int connect_timeout;
71 extern int send_msgs_to_gen;
72 extern pid_t cleanup_child_pid;
73 extern size_t bwlimit_writemax;
74 extern unsigned int module_dirlen;
75 extern struct stats stats;
76 extern char *stdout_format;
77 extern char *logfile_format;
78 extern char *filesfrom_host;
79 extern char *partial_dir;
80 extern char *dest_option;
81 extern char *rsync_path;
82 extern char *shell_cmd;
83 extern char *batch_name;
84 extern char *password_file;
85 extern char *backup_dir;
86 extern char curr_dir[MAXPATHLEN];
87 extern char backup_dir_buf[MAXPATHLEN];
88 extern char *basis_dir[MAX_BASIS_DIRS+1];
89 extern struct file_list *first_flist;
90 extern filter_rule_list daemon_filter_list;
96 int daemon_over_rsh = 0;
97 mode_t orig_umask = 0;
98 int batch_gen_fd = -1;
99 int sender_keeps_checksum = 0;
101 /* There's probably never more than at most 2 outstanding child processes,
102 * but set it higher, just in case. */
103 #define MAXCHILDPROCS 7
105 #ifdef HAVE_SIGACTION
106 # ifdef HAVE_SIGPROCMASK
107 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
109 # define SIGACTMASK(n,h) SIGACTION(n,h)
111 static struct sigaction sigact;
117 } pid_stat_table[MAXCHILDPROCS];
119 static time_t starttime, endtime;
120 static int64 total_read, total_written;
122 static void show_malloc_stats(void);
124 /* Works like waitpid(), but if we already harvested the child pid in our
125 * remember_children(), we succeed instead of returning an error. */
126 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
131 waited_pid = waitpid(pid, status_ptr, flags);
132 } while (waited_pid == -1 && errno == EINTR);
134 if (waited_pid == -1 && errno == ECHILD) {
135 /* Status of requested child no longer available: check to
136 * see if it was processed by remember_children(). */
138 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
139 if (pid == pid_stat_table[cnt].pid) {
140 *status_ptr = pid_stat_table[cnt].status;
141 pid_stat_table[cnt].pid = 0;
150 /* Wait for a process to exit, calling io_flush while waiting. */
151 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
156 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
158 io_flush(FULL_FLUSH);
161 /* TODO: If the child exited on a signal, then log an
162 * appropriate error message. Perhaps we should also accept a
163 * message describing the purpose of the child. Also indicate
164 * this to the caller so that they know something went wrong. */
165 if (waited_pid < 0) {
166 rsyserr(FERROR, errno, "waitpid");
167 *exit_code_ptr = RERR_WAITCHILD;
168 } else if (!WIFEXITED(status)) {
170 if (WCOREDUMP(status))
171 *exit_code_ptr = RERR_CRASHED;
174 if (WIFSIGNALED(status))
175 *exit_code_ptr = RERR_TERMINATED;
177 *exit_code_ptr = RERR_WAITCHILD;
179 *exit_code_ptr = WEXITSTATUS(status);
182 void write_del_stats(int f)
185 write_int(f, NDX_DEL_STATS);
187 write_ndx(f, NDX_DEL_STATS);
188 write_varint(f, stats.deleted_files - stats.deleted_dirs
189 - stats.deleted_symlinks - stats.deleted_devices
190 - stats.deleted_specials);
191 write_varint(f, stats.deleted_dirs);
192 write_varint(f, stats.deleted_symlinks);
193 write_varint(f, stats.deleted_devices);
194 write_varint(f, stats.deleted_specials);
197 void read_del_stats(int f)
199 stats.deleted_files = read_varint(f);
200 stats.deleted_files += stats.deleted_dirs = read_varint(f);
201 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
202 stats.deleted_files += stats.deleted_devices = read_varint(f);
203 stats.deleted_files += stats.deleted_specials = read_varint(f);
206 /* This function gets called from all 3 processes. We want the client side
207 * to actually output the text, but the sender is the only process that has
208 * all the stats we need. So, if we're a client sender, we do the report.
209 * If we're a server sender, we write the stats on the supplied fd. If
210 * we're the client receiver we read the stats from the supplied fd and do
211 * the report. All processes might also generate a set of debug stats, if
212 * the verbose level is high enough (this is the only thing that the
213 * generator process and the server receiver ever do here). */
214 static void handle_stats(int f)
216 endtime = time(NULL);
218 /* Cache two stats because the read/write code can change it. */
219 total_read = stats.total_read;
220 total_written = stats.total_written;
222 if (INFO_GTE(STATS, 3)) {
223 /* These come out from every process */
232 if (f == -1 || !am_sender)
238 write_varlong30(f, total_read, 3);
239 write_varlong30(f, total_written, 3);
240 write_varlong30(f, stats.total_size, 3);
241 if (protocol_version >= 29) {
242 write_varlong30(f, stats.flist_buildtime, 3);
243 write_varlong30(f, stats.flist_xfertime, 3);
249 /* this is the client */
251 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
253 else if (!am_sender) {
254 /* Read the first two in opposite order because the meaning of
255 * read/write swaps when switching from sender to receiver. */
256 total_written = read_varlong30(f, 3);
257 total_read = read_varlong30(f, 3);
258 stats.total_size = read_varlong30(f, 3);
259 if (protocol_version >= 29) {
260 stats.flist_buildtime = read_varlong30(f, 3);
261 stats.flist_xfertime = read_varlong30(f, 3);
263 } else if (write_batch) {
264 /* The --read-batch process is going to be a client
265 * receiver, so we need to give it the stats. */
266 write_varlong30(batch_fd, total_read, 3);
267 write_varlong30(batch_fd, total_written, 3);
268 write_varlong30(batch_fd, stats.total_size, 3);
269 if (protocol_version >= 29) {
270 write_varlong30(batch_fd, stats.flist_buildtime, 3);
271 write_varlong30(batch_fd, stats.flist_xfertime, 3);
276 static void output_itemized_counts(const char *prefix, int *counts)
278 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
279 char buf[1024], *pre = " (";
281 int total = counts[0];
283 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
284 for (j = 0; j < 5; j++) {
286 len += snprintf(buf+len, sizeof buf - len - 2,
288 pre, labels[j], comma_num(counts[j]));
295 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
298 static void output_summary(void)
300 if (INFO_GTE(STATS, 2)) {
301 rprintf(FCLIENT, "\n");
302 output_itemized_counts("Number of files", &stats.num_files);
303 if (protocol_version >= 29)
304 output_itemized_counts("Number of created files", &stats.created_files);
305 if (protocol_version >= 31)
306 output_itemized_counts("Number of deleted files", &stats.deleted_files);
307 rprintf(FINFO,"Number of regular files transferred: %s\n",
308 comma_num(stats.xferred_files));
309 rprintf(FINFO,"Total file size: %s bytes\n",
310 human_num(stats.total_size));
311 rprintf(FINFO,"Total transferred file size: %s bytes\n",
312 human_num(stats.total_transferred_size));
313 rprintf(FINFO,"Literal data: %s bytes\n",
314 human_num(stats.literal_data));
315 rprintf(FINFO,"Matched data: %s bytes\n",
316 human_num(stats.matched_data));
317 rprintf(FINFO,"File list size: %s\n",
318 human_num(stats.flist_size));
319 if (stats.flist_buildtime) {
321 "File list generation time: %s seconds\n",
322 comma_dnum((double)stats.flist_buildtime / 1000, 3));
324 "File list transfer time: %s seconds\n",
325 comma_dnum((double)stats.flist_xfertime / 1000, 3));
327 rprintf(FINFO,"Total bytes sent: %s\n",
328 human_num(total_written));
329 rprintf(FINFO,"Total bytes received: %s\n",
330 human_num(total_read));
333 if (INFO_GTE(STATS, 1)) {
334 rprintf(FCLIENT, "\n");
336 "sent %s bytes received %s bytes %s bytes/sec\n",
337 human_num(total_written), human_num(total_read),
338 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
339 rprintf(FINFO, "total size is %s speedup is %s%s\n",
340 human_num(stats.total_size),
341 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
342 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
351 * If our C library can get malloc statistics, then show them to FINFO
353 static void show_malloc_stats(void)
360 rprintf(FCLIENT, "\n");
361 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
362 getpid(), am_server ? "server " : "",
363 am_daemon ? "daemon " : "", who_am_i());
364 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
366 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
368 rprintf(FINFO, " smblks: %10ld\n",
370 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
372 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
374 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
375 (long)mi.arena + mi.hblkhd);
376 rprintf(FINFO, " usmblks: %10ld\n",
378 rprintf(FINFO, " fsmblks: %10ld\n",
380 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
382 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
384 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
386 #endif /* HAVE_MALLINFO */
390 /* Start the remote shell. cmd may be NULL to use the default. */
391 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
392 int *f_in_p, int *f_out_p)
395 char *args[MAX_ARGS];
399 if (!read_batch && !local_server) {
400 char *t, *f, in_quote = '\0';
401 char *rsh_env = getenv(RSYNC_RSH_ENV);
406 cmd = strdup(cmd); /* MEMORY LEAK */
410 for (t = f = cmd; *f; f++) {
413 /* Comparison leaves rooms for server_options(). */
414 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
417 while (*f != ' ' || in_quote) {
421 "Missing trailing-%c in remote-shell command.\n",
423 exit_cleanup(RERR_SYNTAX);
428 if (*f == '\'' || *f == '"') {
433 if (*f == in_quote && *++f != in_quote) {
443 /* check to see if we've already been given '-l user' in
444 * the remote-shell command */
445 for (i = 0; i < argc-1; i++) {
446 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
451 /* remsh (on HPUX) takes the arguments the other way around */
452 args[argc++] = machine;
453 if (user && !(daemon_over_rsh && dash_l_set)) {
458 if (user && !(daemon_over_rsh && dash_l_set)) {
462 args[argc++] = machine;
465 args[argc++] = rsync_path;
467 if (blocking_io < 0) {
469 if ((cp = strrchr(cmd, '/')) != NULL)
473 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
477 server_options(args,&argc);
479 if (argc >= MAX_ARGS - 2)
485 if (!daemon_over_rsh) {
486 while (remote_argc > 0) {
487 if (argc >= MAX_ARGS - 1) {
489 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
490 exit_cleanup(RERR_SYNTAX);
492 args[argc++] = *remote_argv++;
499 if (DEBUG_GTE(CMD, 2)) {
500 for (i = 0; i < argc; i++)
501 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
502 rprintf(FCLIENT, "\n");
506 int from_gen_pipe[2];
507 set_allow_inc_recurse();
508 if (fd_pair(from_gen_pipe) < 0) {
509 rsyserr(FERROR, errno, "pipe");
510 exit_cleanup(RERR_IPC);
512 batch_gen_fd = from_gen_pipe[0];
513 *f_out_p = from_gen_pipe[1];
515 pid = (pid_t)-1; /* no child pid */
519 } else if (local_server) {
520 /* If the user didn't request --[no-]whole-file, force
521 * it on, but only if we're not batch processing. */
522 if (whole_file < 0 && !write_batch)
524 set_allow_inc_recurse();
525 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
530 pid = piped_child(args, f_in_p, f_out_p);
534 if (protect_args && !daemon_over_rsh)
535 send_protected_args(*f_out_p, args);
541 out_of_memory("do_cmd");
542 return 0; /* not reached */
545 /* The receiving side operates in one of two modes:
547 * 1. it receives any number of files into a destination directory,
548 * placing them according to their names in the file-list.
550 * 2. it receives a single file and saves it using the name in the
551 * destination path instead of its file-list name. This requires a
552 * "local name" for writing out the destination file.
554 * So, our task is to figure out what mode/local-name we need.
555 * For mode 1, we change into the destination directory and return NULL.
556 * For mode 2, we change into the directory containing the destination
557 * file (if we aren't already there) and return the local-name. */
558 static char *get_local_name(struct file_list *flist, char *dest_path)
564 if (DEBUG_GTE(RECV, 1)) {
565 rprintf(FINFO, "get_local_name count=%d %s\n",
566 file_total, NS(dest_path));
569 if (!dest_path || list_only)
572 if (daemon_filter_list.head) {
573 char *slash = strrchr(dest_path, '/');
574 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
578 if ((*dest_path != '.' || dest_path[1] != '\0')
579 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
580 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
581 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
583 exit_cleanup(RERR_FILESELECT);
589 /* See what currently exists at the destination. */
590 if ((statret = do_stat(dest_path, &st)) == 0) {
591 /* If the destination is a dir, enter it and use mode 1. */
592 if (S_ISDIR(st.st_mode)) {
593 if (!change_dir(dest_path, CD_NORMAL)) {
594 rsyserr(FERROR, errno, "change_dir#1 %s failed",
595 full_fname(dest_path));
596 exit_cleanup(RERR_FILESELECT);
600 if (file_total > 1) {
602 "ERROR: destination must be a directory when"
603 " copying more than 1 file\n");
604 exit_cleanup(RERR_FILESELECT);
606 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
608 "ERROR: cannot overwrite non-directory"
609 " with a directory\n");
610 exit_cleanup(RERR_FILESELECT);
612 } else if (errno != ENOENT) {
613 /* If we don't know what's at the destination, fail. */
614 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
615 full_fname(dest_path));
616 exit_cleanup(RERR_FILESELECT);
619 cp = strrchr(dest_path, '/');
621 /* If we need a destination directory because the transfer is not
622 * of a single non-directory or the user has requested one via a
623 * destination path ending in a slash, create one and use mode 1. */
624 if (file_total > 1 || (cp && !cp[1])) {
625 /* Lop off the final slash (if any). */
631 "ERROR: destination path is not a directory\n");
632 exit_cleanup(RERR_SYNTAX);
635 if (mkdir_defmode(dest_path) != 0) {
636 rsyserr(FERROR, errno, "mkdir %s failed",
637 full_fname(dest_path));
638 exit_cleanup(RERR_FILEIO);
641 if (flist->high >= flist->low
642 && strcmp(flist->files[flist->low]->basename, ".") == 0)
643 flist->files[0]->flags |= FLAG_DIR_CREATED;
645 if (INFO_GTE(NAME, 1))
646 rprintf(FINFO, "created directory %s\n", dest_path);
649 /* Indicate that dest dir doesn't really exist. */
653 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
654 rsyserr(FERROR, errno, "change_dir#2 %s failed",
655 full_fname(dest_path));
656 exit_cleanup(RERR_FILESELECT);
662 /* Otherwise, we are writing a single file, possibly on top of an
663 * existing non-directory. Change to the item's parent directory
664 * (if it has a path component), return the basename of the
665 * destination file as the local name, and use mode 2. */
673 if (!change_dir(dest_path, CD_NORMAL)) {
674 rsyserr(FERROR, errno, "change_dir#3 %s failed",
675 full_fname(dest_path));
676 exit_cleanup(RERR_FILESELECT);
683 /* This function checks on our alternate-basis directories. If we're in
684 * dry-run mode and the destination dir does not yet exist, we'll try to
685 * tweak any dest-relative paths to make them work for a dry-run (the
686 * destination dir must be in curr_dir[] when this function is called).
687 * We also warn about any arg that is non-existent or not a directory. */
688 static void check_alt_basis_dirs(void)
691 char **dir_p, *slash = strrchr(curr_dir, '/');
693 for (dir_p = basis_dir; *dir_p; dir_p++) {
694 if (dry_run > 1 && **dir_p != '/') {
695 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
696 char *new = new_array(char, len);
698 out_of_memory("check_alt_basis_dirs");
699 if (slash && strncmp(*dir_p, "../", 3) == 0) {
700 /* We want to remove only one leading "../" prefix for
701 * the directory we couldn't create in dry-run mode:
702 * this ensures that any other ".." references get
703 * evaluated the same as they would for a live copy. */
705 pathjoin(new, len, curr_dir, *dir_p + 3);
708 pathjoin(new, len, curr_dir, *dir_p);
711 if (do_stat(*dir_p, &st) < 0) {
712 rprintf(FWARNING, "%s arg does not exist: %s\n",
713 dest_option, *dir_p);
714 } else if (!S_ISDIR(st.st_mode)) {
715 rprintf(FWARNING, "%s arg is not a dir: %s\n",
716 dest_option, *dir_p);
721 /* This is only called by the sender. */
722 static void read_final_goodbye(int f_in, int f_out)
726 char xname[MAXPATHLEN];
728 if (protocol_version < 29)
731 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
732 if (protocol_version >= 31 && i == NDX_DONE) {
734 write_ndx(f_out, NDX_DONE);
736 if (batch_gen_fd >= 0) {
737 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
738 read_del_stats(batch_gen_fd);
740 write_int(f_out, NDX_DONE);
742 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
747 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
749 exit_cleanup(RERR_PROTOCOL);
753 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
755 struct file_list *flist;
758 if (DEBUG_GTE(SEND, 1)) {
759 rprintf(FINFO, "server_sender starting pid=%ld\n",
763 if (am_daemon && lp_write_only(module_id)) {
764 rprintf(FERROR, "ERROR: module is write only\n");
765 exit_cleanup(RERR_SYNTAX);
768 if (am_daemon && read_only && remove_source_files) {
770 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
771 remove_source_files == 1 ? "source" : "sent");
772 exit_cleanup(RERR_SYNTAX);
776 if (!relative_paths) {
777 if (!change_dir(dir, CD_NORMAL)) {
778 rsyserr(FERROR, errno, "change_dir#3 %s failed",
780 exit_cleanup(RERR_FILESELECT);
786 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
792 flist = send_file_list(f_out,argc,argv);
793 if (!flist || flist->used == 0)
796 io_start_buffering_in(f_in);
798 send_files(f_in, f_out);
799 io_flush(FULL_FLUSH);
801 if (protocol_version >= 24)
802 read_final_goodbye(f_in, f_out);
803 io_flush(FULL_FLUSH);
808 static int do_recv(int f_in, int f_out, char *local_name)
814 /* The receiving side mustn't obey this, or an existing symlink that
815 * points to an identical file won't be replaced by the referent. */
816 copy_links = copy_dirlinks = copy_unsafe_links = 0;
818 #ifdef SUPPORT_HARD_LINKS
819 if (preserve_hard_links && !inc_recurse)
820 match_hard_links(first_flist);
823 if (fd_pair(error_pipe) < 0) {
824 rsyserr(FERROR, errno, "pipe failed in do_recv");
825 exit_cleanup(RERR_IPC);
829 int ret = make_path(backup_dir_buf, MKP_DROP_NAME); /* drops trailing slash */
831 exit_cleanup(RERR_SYNTAX);
833 rprintf(FINFO, "Created backup_dir %s\n", backup_dir_buf);
834 else if (INFO_GTE(BACKUP, 1))
835 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
838 io_flush(FULL_FLUSH);
840 if ((pid = do_fork()) == -1) {
841 rsyserr(FERROR, errno, "fork failed in do_recv");
842 exit_cleanup(RERR_IPC);
846 send_msgs_to_gen = am_server;
848 close(error_pipe[0]);
850 /* We can't let two processes write to the socket at one time. */
851 io_end_multiplex_out(False);
855 f_out = error_pipe[1];
857 bwlimit_writemax = 0; /* receiver doesn't need to do this */
860 io_start_buffering_in(f_in);
861 io_start_multiplex_out(f_out);
863 recv_files(f_in, f_out, local_name);
864 io_flush(FULL_FLUSH);
867 if (output_needs_newline) {
869 output_needs_newline = 0;
872 write_int(f_out, NDX_DONE);
873 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
874 io_flush(FULL_FLUSH);
876 /* Handle any keep-alive packets from the post-processing work
877 * that the generator does. */
878 if (protocol_version >= 29) {
879 kluge_around_eof = -1;
881 /* This should only get stopped via a USR2 signal. */
882 read_final_goodbye(f_in, f_out);
884 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
886 exit_cleanup(RERR_PROTOCOL);
889 /* Finally, we go to sleep until our parent kills us with a
890 * USR2 signal. We sleep for a short time, as on some OSes
891 * a signal won't interrupt a sleep! */
898 io_end_multiplex_in(False);
899 if (write_batch && !am_server)
902 close(error_pipe[1]);
906 f_in = error_pipe[0];
908 io_start_buffering_out(f_out);
909 io_start_multiplex_in(f_in);
911 #ifdef SUPPORT_HARD_LINKS
912 if (preserve_hard_links && inc_recurse) {
913 struct file_list *flist;
914 for (flist = first_flist; flist; flist = flist->next)
915 match_hard_links(flist);
919 generate_files(f_out, local_name);
922 io_flush(FULL_FLUSH);
923 if (protocol_version >= 24) {
924 /* send a final goodbye message */
925 write_ndx(f_out, NDX_DONE);
927 io_flush(FULL_FLUSH);
930 wait_process_with_flush(pid, &exit_code);
934 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
937 struct file_list *flist;
938 char *local_name = NULL;
941 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
942 /* We can't mix messages with files-from data on the socket,
943 * so temporarily turn off info/debug messages. */
944 negate_output_levels();
949 if (DEBUG_GTE(RECV, 1)) {
950 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
951 argc, (long)getpid());
954 if (am_daemon && read_only) {
955 rprintf(FERROR,"ERROR: module is read only\n");
956 exit_cleanup(RERR_SYNTAX);
964 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
965 rsyserr(FERROR, errno, "change_dir#4 %s failed",
967 exit_cleanup(RERR_FILESELECT);
971 if (protocol_version >= 30)
972 io_start_multiplex_in(f_in);
974 io_start_buffering_in(f_in);
975 recv_filter_list(f_in);
977 if (filesfrom_fd >= 0) {
978 /* We need to send the files-from names to the sender at the
979 * same time that we receive the file-list from them, so we
980 * need the IO routines to automatically write out the names
981 * onto our f_out socket as we read the file-list. This
982 * avoids both deadlock and extra delays/buffers. */
983 start_filesfrom_forwarding(filesfrom_fd);
987 flist = recv_file_list(f_in);
989 rprintf(FERROR,"server_recv: recv_file_list error\n");
990 exit_cleanup(RERR_FILESELECT);
992 if (inc_recurse && file_total == 1)
993 recv_additional_file_list(f_in);
996 negate_output_levels();
999 local_name = get_local_name(flist,argv[0]);
1001 /* Now that we know what our destination directory turned out to be,
1002 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1003 if (sanitize_paths) {
1005 for (dir_p = basis_dir; *dir_p; dir_p++)
1006 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1008 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1010 check_alt_basis_dirs();
1012 if (daemon_filter_list.head) {
1014 filter_rule_list *elp = &daemon_filter_list;
1016 for (dir_p = basis_dir; *dir_p; dir_p++) {
1019 dir += module_dirlen;
1020 if (check_filter(elp, FLOG, dir, 1) < 0)
1021 goto options_rejected;
1023 if (partial_dir && *partial_dir == '/'
1024 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1027 "Your options have been rejected by the server.\n");
1028 exit_cleanup(RERR_SYNTAX);
1032 exit_code = do_recv(f_in, f_out, local_name);
1033 exit_cleanup(exit_code);
1037 int child_main(int argc, char *argv[])
1039 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1044 void start_server(int f_in, int f_out, int argc, char *argv[])
1046 set_nonblocking(f_in);
1047 set_nonblocking(f_out);
1049 io_set_sock_fds(f_in, f_out);
1050 setup_protocol(f_out, f_in);
1052 if (protocol_version >= 23)
1053 io_start_multiplex_out(f_out);
1056 keep_dirlinks = 0; /* Must be disabled on the sender. */
1057 if (need_messages_from_generator)
1058 io_start_multiplex_in(f_in);
1059 recv_filter_list(f_in);
1060 do_server_sender(f_in, f_out, argc, argv);
1062 do_server_recv(f_in, f_out, argc, argv);
1066 /* This is called once the connection has been negotiated. It is used
1067 * for rsyncd, remote-shell, and local connections. */
1068 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1070 struct file_list *flist = NULL;
1071 int exit_code = 0, exit_code2 = 0;
1072 char *local_name = NULL;
1074 cleanup_child_pid = pid;
1076 set_nonblocking(f_in);
1077 set_nonblocking(f_out);
1080 io_set_sock_fds(f_in, f_out);
1081 setup_protocol(f_out,f_in);
1083 /* We set our stderr file handle to blocking because ssh might have
1084 * set it to non-blocking. This can be particularly troublesome if
1085 * stderr is a clone of stdout, because ssh would have set our stdout
1086 * to non-blocking at the same time (which can easily cause us to lose
1087 * output from our print statements). This kluge shouldn't cause ssh
1088 * any problems for how we use it. Note also that we delayed setting
1089 * this until after the above protocol setup so that we know for sure
1090 * that ssh is done twiddling its file descriptors. */
1091 set_blocking(STDERR_FILENO);
1094 keep_dirlinks = 0; /* Must be disabled on the sender. */
1097 && (log_format_has(stdout_format, 'C')
1098 || log_format_has(logfile_format, 'C')))
1099 sender_keeps_checksum = 1;
1101 if (protocol_version >= 30)
1102 io_start_multiplex_out(f_out);
1104 io_start_buffering_out(f_out);
1105 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1106 io_start_multiplex_in(f_in);
1107 send_filter_list(f_out);
1109 filesfrom_fd = f_in;
1111 if (write_batch && !am_server)
1112 start_write_batch(f_out);
1113 flist = send_file_list(f_out, argc, argv);
1114 if (DEBUG_GTE(FLIST, 3))
1115 rprintf(FINFO,"file list sent\n");
1117 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1118 io_start_multiplex_in(f_in);
1120 io_flush(NORMAL_FLUSH);
1121 send_files(f_in, f_out);
1122 io_flush(FULL_FLUSH);
1124 if (protocol_version >= 24)
1125 read_final_goodbye(f_in, f_out);
1127 if (DEBUG_GTE(EXIT, 2))
1128 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1129 io_flush(FULL_FLUSH);
1130 wait_process_with_flush(pid, &exit_code);
1133 io_flush(FULL_FLUSH);
1134 exit_cleanup(exit_code);
1138 if (protocol_version >= 23)
1139 io_start_multiplex_in(f_in);
1140 if (need_messages_from_generator)
1141 io_start_multiplex_out(f_out);
1144 send_filter_list(read_batch ? -1 : f_out);
1146 if (filesfrom_fd >= 0) {
1147 start_filesfrom_forwarding(filesfrom_fd);
1151 if (write_batch && !am_server)
1152 start_write_batch(f_in);
1153 flist = recv_file_list(f_in);
1154 if (inc_recurse && file_total == 1)
1155 recv_additional_file_list(f_in);
1157 if (flist && flist->used > 0) {
1158 local_name = get_local_name(flist, argv[0]);
1160 check_alt_basis_dirs();
1162 exit_code2 = do_recv(f_in, f_out, local_name);
1169 if (DEBUG_GTE(RECV, 1))
1170 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1171 io_flush(FULL_FLUSH);
1172 wait_process_with_flush(pid, &exit_code);
1175 return MAX(exit_code, exit_code2);
1178 static int copy_argv(char *argv[])
1182 for (i = 0; argv[i]; i++) {
1183 if (!(argv[i] = strdup(argv[i]))) {
1184 rprintf (FERROR, "out of memory at %s(%d)\n",
1185 __FILE__, __LINE__);
1194 /* Start a client for either type of remote connection. Work out
1195 * whether the arguments request a remote shell or rsyncd connection,
1196 * and call the appropriate connection function, then run_client.
1198 * Calls either start_socket_client (for sockets) or do_cmd and
1199 * client_run (for ssh). */
1200 static int start_client(int argc, char *argv[])
1202 char *p, *shell_machine = NULL, *shell_user = NULL;
1209 /* Don't clobber argv[] so that ps(1) can still show the right
1211 if ((ret = copy_argv(argv)) != 0)
1214 if (!read_batch) { /* for read_batch, NO source is specified */
1215 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1216 if (path) { /* source is remote */
1223 if (argc == 1 || **argv == ':')
1224 argc = 0; /* no dest arg */
1225 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1227 "The source and destination cannot both be remote.\n");
1228 exit_cleanup(RERR_SYNTAX);
1230 remote_argc--; /* don't count dest */
1233 if (filesfrom_host && *filesfrom_host
1234 && strcmp(filesfrom_host, shell_machine) != 0) {
1236 "--files-from hostname is not the same as the transfer hostname\n");
1237 exit_cleanup(RERR_SYNTAX);
1241 daemon_over_rsh = shell_cmd ? 1 : -1;
1242 } else { /* source is local, check dest arg */
1247 remote_argv = argv + argc;
1249 static char *dotarg[1] = { "." };
1251 remote_argv = dotarg;
1255 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1256 if (path && filesfrom_host && *filesfrom_host
1257 && strcmp(filesfrom_host, shell_machine) != 0) {
1259 "--files-from hostname is not the same as the transfer hostname\n");
1260 exit_cleanup(RERR_SYNTAX);
1262 if (!path) { /* no hostspec found, so src & dest are local */
1264 if (filesfrom_host) {
1266 "--files-from cannot be remote when the transfer is local\n");
1267 exit_cleanup(RERR_SYNTAX);
1269 shell_machine = NULL;
1270 } else { /* hostspec was found, so dest is remote */
1273 daemon_over_rsh = shell_cmd ? 1 : -1;
1276 } else { /* read_batch */
1278 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1279 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1280 exit_cleanup(RERR_SYNTAX);
1282 remote_argv = argv += argc - 1;
1283 remote_argc = argc = 1;
1288 int dummy_port = rsync_port;
1290 /* For local source, extra source args must not have hostspec. */
1291 for (i = 1; i < argc; i++) {
1292 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1293 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1294 exit_cleanup(RERR_SYNTAX);
1299 int dummy_port = rsync_port;
1301 /* For remote source, any extra source args must have either
1302 * the same hostname or an empty hostname. */
1303 for (i = 1; i < remote_argc; i++) {
1304 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1306 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1307 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1308 exit_cleanup(RERR_SYNTAX);
1310 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1311 rprintf(FERROR, "All source args must come from the same machine.\n");
1312 exit_cleanup(RERR_SYNTAX);
1314 if (rsync_port != dummy_port) {
1315 if (!rsync_port || !dummy_port)
1316 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1318 rprintf(FERROR, "All source args must use the same port number.\n");
1319 exit_cleanup(RERR_SYNTAX);
1321 remote_argv[i] = arg;
1325 if (daemon_over_rsh < 0)
1326 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1328 if (password_file && !daemon_over_rsh) {
1329 rprintf(FERROR, "The --password-file option may only be "
1330 "used when accessing an rsync daemon.\n");
1331 exit_cleanup(RERR_SYNTAX);
1334 if (connect_timeout) {
1335 rprintf(FERROR, "The --contimeout option may only be "
1336 "used when connecting to an rsync daemon.\n");
1337 exit_cleanup(RERR_SYNTAX);
1340 if (shell_machine) {
1341 p = strrchr(shell_machine,'@');
1344 shell_user = shell_machine;
1345 shell_machine = p+1;
1349 if (DEBUG_GTE(CMD, 2)) {
1350 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1351 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1352 remote_argv ? NS(remote_argv[0]) : "");
1355 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1358 /* if we're running an rsync server on the remote host over a
1359 * remote shell command, we need to do the RSYNCD protocol first */
1360 if (daemon_over_rsh) {
1362 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1367 ret = client_run(f_in, f_out, pid, argc, argv);
1376 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1378 exit_cleanup(RERR_SIGNAL1);
1381 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1387 _exit(RERR_PARTIAL);
1391 RETSIGTYPE remember_children(UNUSED(int val))
1396 /* An empty waitpid() loop was put here by Tridge and we could never
1397 * get him to explain why he put it in, so rather than taking it
1398 * out we're instead saving the child exit statuses for later use.
1399 * The waitpid() loop presumably eliminates all possibility of leaving
1400 * zombie children, maybe that's why he did it. */
1401 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1402 /* save the child's exit status */
1403 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1404 if (pid_stat_table[cnt].pid == 0) {
1405 pid_stat_table[cnt].pid = pid;
1406 pid_stat_table[cnt].status = status;
1412 #ifndef HAVE_SIGACTION
1413 signal(SIGCHLD, remember_children);
1419 * This routine catches signals and tries to send them to gdb.
1421 * Because it's called from inside a signal handler it ought not to
1422 * use too many library routines.
1424 * @todo Perhaps use "screen -X" instead/as well, to help people
1425 * debugging without easy access to X. Perhaps use an environment
1426 * variable, or just call a script?
1428 * @todo The /proc/ magic probably only works on Linux (and
1429 * Solaris?) Can we be more portable?
1431 #ifdef MAINTAINER_MODE
1432 const char *get_panic_action(void)
1434 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1439 return "xterm -display :0 -T Panic -n Panic "
1440 "-e gdb /proc/%d/exe %d";
1445 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1447 * This signal handler is only installed if we were configured with
1448 * --enable-maintainer-mode. Perhaps it should always be on and we
1449 * should just look at the environment variable, but I'm a bit leery
1450 * of a signal sending us into a busy loop.
1452 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1457 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1458 getpid(), getpid());
1460 /* Unless we failed to execute gdb, we allow the process to
1461 * continue. I'm not sure if that's right. */
1462 ret = system(cmd_buf);
1469 int main(int argc,char *argv[])
1472 int orig_argc = argc;
1473 char **orig_argv = argv;
1474 #ifdef HAVE_SIGACTION
1475 # ifdef HAVE_SIGPROCMASK
1478 sigemptyset(&sigmask);
1480 sigact.sa_flags = SA_NOCLDSTOP;
1482 SIGACTMASK(SIGUSR1, sigusr1_handler);
1483 SIGACTMASK(SIGUSR2, sigusr2_handler);
1484 SIGACTMASK(SIGCHLD, remember_children);
1485 #ifdef MAINTAINER_MODE
1486 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1487 SIGACTMASK(SIGFPE, rsync_panic_handler);
1488 SIGACTMASK(SIGABRT, rsync_panic_handler);
1489 SIGACTMASK(SIGBUS, rsync_panic_handler);
1492 starttime = time(NULL);
1495 am_root = our_uid == 0;
1497 memset(&stats, 0, sizeof(stats));
1501 exit_cleanup(RERR_SYNTAX);
1504 /* we set a 0 umask so that correct file permissions can be
1506 orig_umask = umask(0);
1508 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1509 setlocale(LC_CTYPE, "");
1512 if (!parse_arguments(&argc, (const char ***) &argv)) {
1513 /* FIXME: We ought to call the same error-handling
1514 * code here, rather than relying on getopt. */
1516 exit_cleanup(RERR_SYNTAX);
1519 SIGACTMASK(SIGINT, sig_int);
1520 SIGACTMASK(SIGHUP, sig_int);
1521 SIGACTMASK(SIGTERM, sig_int);
1522 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1523 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1526 /* Ignore SIGPIPE; we consistently check error codes and will
1528 SIGACTION(SIGPIPE, SIG_IGN);
1530 SIGACTION(SIGXFSZ, SIG_IGN);
1533 /* Initialize change_dir() here because on some old systems getcwd
1534 * (implemented by forking "pwd" and reading its output) doesn't
1535 * work when there are other child processes. Also, on all systems
1536 * that implement getcwd that way "pwd" can't be found after chroot. */
1537 change_dir(NULL, CD_NORMAL);
1541 if ((write_batch || read_batch) && !am_server) {
1543 write_batch_shell_file(orig_argc, orig_argv, argc);
1545 if (read_batch && strcmp(batch_name, "-") == 0)
1546 batch_fd = STDIN_FILENO;
1548 batch_fd = do_open(batch_name,
1549 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1550 : O_RDONLY, S_IRUSR | S_IWUSR);
1553 rsyserr(FERROR, errno, "Batch file %s open error",
1554 full_fname(batch_name));
1555 exit_cleanup(RERR_FILEIO);
1558 read_stream_flags(batch_fd);
1560 write_stream_flags(batch_fd);
1562 if (write_batch < 0)
1569 } else if (am_daemon)
1570 return daemon_main();
1572 if (am_server && protect_args) {
1573 char buf[MAXPATHLEN];
1575 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1576 if (!parse_arguments(&argc, (const char ***) &argv)) {
1578 exit_cleanup(RERR_SYNTAX);
1584 exit_cleanup(RERR_SYNTAX);
1588 set_nonblocking(STDIN_FILENO);
1589 set_nonblocking(STDOUT_FILENO);
1591 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1592 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1595 ret = start_client(argc, argv);
1597 exit_cleanup(RERR_STARTCLIENT);