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 BOOL flist_receiving_enabled;
77 extern BOOL shutting_down;
78 extern struct stats stats;
79 extern char *stdout_format;
80 extern char *logfile_format;
81 extern char *filesfrom_host;
82 extern char *partial_dir;
83 extern char *dest_option;
84 extern char *rsync_path;
85 extern char *shell_cmd;
86 extern char *batch_name;
87 extern char *password_file;
88 extern char *backup_dir;
89 extern char curr_dir[MAXPATHLEN];
90 extern char backup_dir_buf[MAXPATHLEN];
91 extern char *basis_dir[MAX_BASIS_DIRS+1];
92 extern struct file_list *first_flist;
93 extern filter_rule_list daemon_filter_list;
97 int am_receiver = 0; /* Only set to 1 after the receiver/generator fork. */
98 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
100 int daemon_over_rsh = 0;
101 mode_t orig_umask = 0;
102 int batch_gen_fd = -1;
103 int sender_keeps_checksum = 0;
105 /* There's probably never more than at most 2 outstanding child processes,
106 * but set it higher, just in case. */
107 #define MAXCHILDPROCS 7
109 #ifdef HAVE_SIGACTION
110 # ifdef HAVE_SIGPROCMASK
111 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
113 # define SIGACTMASK(n,h) SIGACTION(n,h)
115 static struct sigaction sigact;
121 } pid_stat_table[MAXCHILDPROCS];
123 static time_t starttime, endtime;
124 static int64 total_read, total_written;
126 static void show_malloc_stats(void);
128 /* Works like waitpid(), but if we already harvested the child pid in our
129 * remember_children(), we succeed instead of returning an error. */
130 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
135 waited_pid = waitpid(pid, status_ptr, flags);
136 } while (waited_pid == -1 && errno == EINTR);
138 if (waited_pid == -1 && errno == ECHILD) {
139 /* Status of requested child no longer available: check to
140 * see if it was processed by remember_children(). */
142 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
143 if (pid == pid_stat_table[cnt].pid) {
144 *status_ptr = pid_stat_table[cnt].status;
145 pid_stat_table[cnt].pid = 0;
154 /* Wait for a process to exit, calling io_flush while waiting. */
155 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
160 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
162 io_flush(FULL_FLUSH);
165 /* TODO: If the child exited on a signal, then log an
166 * appropriate error message. Perhaps we should also accept a
167 * message describing the purpose of the child. Also indicate
168 * this to the caller so that they know something went wrong. */
169 if (waited_pid < 0) {
170 rsyserr(FERROR, errno, "waitpid");
171 *exit_code_ptr = RERR_WAITCHILD;
172 } else if (!WIFEXITED(status)) {
174 if (WCOREDUMP(status))
175 *exit_code_ptr = RERR_CRASHED;
178 if (WIFSIGNALED(status))
179 *exit_code_ptr = RERR_TERMINATED;
181 *exit_code_ptr = RERR_WAITCHILD;
183 *exit_code_ptr = WEXITSTATUS(status);
186 void write_del_stats(int f)
189 write_int(f, NDX_DEL_STATS);
191 write_ndx(f, NDX_DEL_STATS);
192 write_varint(f, stats.deleted_files - stats.deleted_dirs
193 - stats.deleted_symlinks - stats.deleted_devices
194 - stats.deleted_specials);
195 write_varint(f, stats.deleted_dirs);
196 write_varint(f, stats.deleted_symlinks);
197 write_varint(f, stats.deleted_devices);
198 write_varint(f, stats.deleted_specials);
201 void read_del_stats(int f)
203 stats.deleted_files = read_varint(f);
204 stats.deleted_files += stats.deleted_dirs = read_varint(f);
205 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
206 stats.deleted_files += stats.deleted_devices = read_varint(f);
207 stats.deleted_files += stats.deleted_specials = read_varint(f);
210 /* This function gets called from all 3 processes. We want the client side
211 * to actually output the text, but the sender is the only process that has
212 * all the stats we need. So, if we're a client sender, we do the report.
213 * If we're a server sender, we write the stats on the supplied fd. If
214 * we're the client receiver we read the stats from the supplied fd and do
215 * the report. All processes might also generate a set of debug stats, if
216 * the verbose level is high enough (this is the only thing that the
217 * generator process and the server receiver ever do here). */
218 static void handle_stats(int f)
220 endtime = time(NULL);
222 /* Cache two stats because the read/write code can change it. */
223 total_read = stats.total_read;
224 total_written = stats.total_written;
226 if (INFO_GTE(STATS, 3)) {
227 /* These come out from every process */
236 if (f == -1 || !am_sender)
242 write_varlong30(f, total_read, 3);
243 write_varlong30(f, total_written, 3);
244 write_varlong30(f, stats.total_size, 3);
245 if (protocol_version >= 29) {
246 write_varlong30(f, stats.flist_buildtime, 3);
247 write_varlong30(f, stats.flist_xfertime, 3);
253 /* this is the client */
255 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
257 else if (!am_sender) {
258 /* Read the first two in opposite order because the meaning of
259 * read/write swaps when switching from sender to receiver. */
260 total_written = read_varlong30(f, 3);
261 total_read = read_varlong30(f, 3);
262 stats.total_size = read_varlong30(f, 3);
263 if (protocol_version >= 29) {
264 stats.flist_buildtime = read_varlong30(f, 3);
265 stats.flist_xfertime = read_varlong30(f, 3);
267 } else if (write_batch) {
268 /* The --read-batch process is going to be a client
269 * receiver, so we need to give it the stats. */
270 write_varlong30(batch_fd, total_read, 3);
271 write_varlong30(batch_fd, total_written, 3);
272 write_varlong30(batch_fd, stats.total_size, 3);
273 if (protocol_version >= 29) {
274 write_varlong30(batch_fd, stats.flist_buildtime, 3);
275 write_varlong30(batch_fd, stats.flist_xfertime, 3);
280 static void output_itemized_counts(const char *prefix, int *counts)
282 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
283 char buf[1024], *pre = " (";
285 int total = counts[0];
287 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
288 for (j = 0; j < 5; j++) {
290 len += snprintf(buf+len, sizeof buf - len - 2,
292 pre, labels[j], comma_num(counts[j]));
299 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
302 static void output_summary(void)
304 if (INFO_GTE(STATS, 2)) {
305 rprintf(FCLIENT, "\n");
306 output_itemized_counts("Number of files", &stats.num_files);
307 if (protocol_version >= 29)
308 output_itemized_counts("Number of created files", &stats.created_files);
309 if (protocol_version >= 31)
310 output_itemized_counts("Number of deleted files", &stats.deleted_files);
311 rprintf(FINFO,"Number of regular files transferred: %s\n",
312 comma_num(stats.xferred_files));
313 rprintf(FINFO,"Total file size: %s bytes\n",
314 human_num(stats.total_size));
315 rprintf(FINFO,"Total transferred file size: %s bytes\n",
316 human_num(stats.total_transferred_size));
317 rprintf(FINFO,"Literal data: %s bytes\n",
318 human_num(stats.literal_data));
319 rprintf(FINFO,"Matched data: %s bytes\n",
320 human_num(stats.matched_data));
321 rprintf(FINFO,"File list size: %s\n",
322 human_num(stats.flist_size));
323 if (stats.flist_buildtime) {
325 "File list generation time: %s seconds\n",
326 comma_dnum((double)stats.flist_buildtime / 1000, 3));
328 "File list transfer time: %s seconds\n",
329 comma_dnum((double)stats.flist_xfertime / 1000, 3));
331 rprintf(FINFO,"Total bytes sent: %s\n",
332 human_num(total_written));
333 rprintf(FINFO,"Total bytes received: %s\n",
334 human_num(total_read));
337 if (INFO_GTE(STATS, 1)) {
338 rprintf(FCLIENT, "\n");
340 "sent %s bytes received %s bytes %s bytes/sec\n",
341 human_num(total_written), human_num(total_read),
342 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
343 rprintf(FINFO, "total size is %s speedup is %s%s\n",
344 human_num(stats.total_size),
345 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
346 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
355 * If our C library can get malloc statistics, then show them to FINFO
357 static void show_malloc_stats(void)
364 rprintf(FCLIENT, "\n");
365 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
366 getpid(), am_server ? "server " : "",
367 am_daemon ? "daemon " : "", who_am_i());
368 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
370 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
372 rprintf(FINFO, " smblks: %10ld\n",
374 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
376 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
378 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
379 (long)mi.arena + mi.hblkhd);
380 rprintf(FINFO, " usmblks: %10ld\n",
382 rprintf(FINFO, " fsmblks: %10ld\n",
384 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
386 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
388 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
390 #endif /* HAVE_MALLINFO */
394 /* Start the remote shell. cmd may be NULL to use the default. */
395 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
396 int *f_in_p, int *f_out_p)
399 char *args[MAX_ARGS], *need_to_free = NULL;
403 if (!read_batch && !local_server) {
404 char *t, *f, in_quote = '\0';
405 char *rsh_env = getenv(RSYNC_RSH_ENV);
410 cmd = need_to_free = strdup(cmd);
414 for (t = f = cmd; *f; f++) {
417 /* Comparison leaves rooms for server_options(). */
418 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
421 while (*f != ' ' || in_quote) {
425 "Missing trailing-%c in remote-shell command.\n",
427 exit_cleanup(RERR_SYNTAX);
432 if (*f == '\'' || *f == '"') {
437 if (*f == in_quote && *++f != in_quote) {
447 /* check to see if we've already been given '-l user' in
448 * the remote-shell command */
449 for (i = 0; i < argc-1; i++) {
450 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
455 /* remsh (on HPUX) takes the arguments the other way around */
456 args[argc++] = machine;
457 if (user && !(daemon_over_rsh && dash_l_set)) {
462 if (user && !(daemon_over_rsh && dash_l_set)) {
466 args[argc++] = machine;
469 args[argc++] = rsync_path;
471 if (blocking_io < 0) {
473 if ((cp = strrchr(cmd, '/')) != NULL)
477 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
481 server_options(args,&argc);
483 if (argc >= MAX_ARGS - 2)
489 if (!daemon_over_rsh) {
490 while (remote_argc > 0) {
491 if (argc >= MAX_ARGS - 1) {
493 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
494 exit_cleanup(RERR_SYNTAX);
496 args[argc++] = *remote_argv++;
503 if (DEBUG_GTE(CMD, 2)) {
504 for (i = 0; i < argc; i++)
505 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
506 rprintf(FCLIENT, "\n");
510 int from_gen_pipe[2];
511 set_allow_inc_recurse();
512 if (fd_pair(from_gen_pipe) < 0) {
513 rsyserr(FERROR, errno, "pipe");
514 exit_cleanup(RERR_IPC);
516 batch_gen_fd = from_gen_pipe[0];
517 *f_out_p = from_gen_pipe[1];
519 pid = (pid_t)-1; /* no child pid */
523 } else if (local_server) {
524 /* If the user didn't request --[no-]whole-file, force
525 * it on, but only if we're not batch processing. */
526 if (whole_file < 0 && !write_batch)
528 set_allow_inc_recurse();
529 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
534 pid = piped_child(args, f_in_p, f_out_p);
538 if (protect_args && !daemon_over_rsh)
539 send_protected_args(*f_out_p, args);
548 out_of_memory("do_cmd");
549 return 0; /* not reached */
552 /* The receiving side operates in one of two modes:
554 * 1. it receives any number of files into a destination directory,
555 * placing them according to their names in the file-list.
557 * 2. it receives a single file and saves it using the name in the
558 * destination path instead of its file-list name. This requires a
559 * "local name" for writing out the destination file.
561 * So, our task is to figure out what mode/local-name we need.
562 * For mode 1, we change into the destination directory and return NULL.
563 * For mode 2, we change into the directory containing the destination
564 * file (if we aren't already there) and return the local-name. */
565 static char *get_local_name(struct file_list *flist, char *dest_path)
571 if (DEBUG_GTE(RECV, 1)) {
572 rprintf(FINFO, "get_local_name count=%d %s\n",
573 file_total, NS(dest_path));
576 if (!dest_path || list_only)
579 if (daemon_filter_list.head) {
580 char *slash = strrchr(dest_path, '/');
581 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
585 if ((*dest_path != '.' || dest_path[1] != '\0')
586 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
587 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
588 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
590 exit_cleanup(RERR_FILESELECT);
596 /* See what currently exists at the destination. */
597 if ((statret = do_stat(dest_path, &st)) == 0) {
598 /* If the destination is a dir, enter it and use mode 1. */
599 if (S_ISDIR(st.st_mode)) {
600 if (!change_dir(dest_path, CD_NORMAL)) {
601 rsyserr(FERROR, errno, "change_dir#1 %s failed",
602 full_fname(dest_path));
603 exit_cleanup(RERR_FILESELECT);
607 if (file_total > 1) {
609 "ERROR: destination must be a directory when"
610 " copying more than 1 file\n");
611 exit_cleanup(RERR_FILESELECT);
613 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
615 "ERROR: cannot overwrite non-directory"
616 " with a directory\n");
617 exit_cleanup(RERR_FILESELECT);
619 } else if (errno != ENOENT) {
620 /* If we don't know what's at the destination, fail. */
621 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
622 full_fname(dest_path));
623 exit_cleanup(RERR_FILESELECT);
626 cp = strrchr(dest_path, '/');
628 /* If we need a destination directory because the transfer is not
629 * of a single non-directory or the user has requested one via a
630 * destination path ending in a slash, create one and use mode 1. */
631 if (file_total > 1 || (cp && !cp[1])) {
632 /* Lop off the final slash (if any). */
638 "ERROR: destination path is not a directory\n");
639 exit_cleanup(RERR_SYNTAX);
642 if (mkdir_defmode(dest_path) != 0) {
643 rsyserr(FERROR, errno, "mkdir %s failed",
644 full_fname(dest_path));
645 exit_cleanup(RERR_FILEIO);
648 if (flist->high >= flist->low
649 && strcmp(flist->files[flist->low]->basename, ".") == 0)
650 flist->files[0]->flags |= FLAG_DIR_CREATED;
652 if (INFO_GTE(NAME, 1))
653 rprintf(FINFO, "created directory %s\n", dest_path);
656 /* Indicate that dest dir doesn't really exist. */
660 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
661 rsyserr(FERROR, errno, "change_dir#2 %s failed",
662 full_fname(dest_path));
663 exit_cleanup(RERR_FILESELECT);
669 /* Otherwise, we are writing a single file, possibly on top of an
670 * existing non-directory. Change to the item's parent directory
671 * (if it has a path component), return the basename of the
672 * destination file as the local name, and use mode 2. */
680 if (!change_dir(dest_path, CD_NORMAL)) {
681 rsyserr(FERROR, errno, "change_dir#3 %s failed",
682 full_fname(dest_path));
683 exit_cleanup(RERR_FILESELECT);
690 /* This function checks on our alternate-basis directories. If we're in
691 * dry-run mode and the destination dir does not yet exist, we'll try to
692 * tweak any dest-relative paths to make them work for a dry-run (the
693 * destination dir must be in curr_dir[] when this function is called).
694 * We also warn about any arg that is non-existent or not a directory. */
695 static void check_alt_basis_dirs(void)
698 char **dir_p, *slash = strrchr(curr_dir, '/');
700 for (dir_p = basis_dir; *dir_p; dir_p++) {
701 if (dry_run > 1 && **dir_p != '/') {
702 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
703 char *new = new_array(char, len);
705 out_of_memory("check_alt_basis_dirs");
706 if (slash && strncmp(*dir_p, "../", 3) == 0) {
707 /* We want to remove only one leading "../" prefix for
708 * the directory we couldn't create in dry-run mode:
709 * this ensures that any other ".." references get
710 * evaluated the same as they would for a live copy. */
712 pathjoin(new, len, curr_dir, *dir_p + 3);
715 pathjoin(new, len, curr_dir, *dir_p);
718 if (do_stat(*dir_p, &st) < 0) {
719 rprintf(FWARNING, "%s arg does not exist: %s\n",
720 dest_option, *dir_p);
721 } else if (!S_ISDIR(st.st_mode)) {
722 rprintf(FWARNING, "%s arg is not a dir: %s\n",
723 dest_option, *dir_p);
728 /* This is only called by the sender. */
729 static void read_final_goodbye(int f_in, int f_out)
733 char xname[MAXPATHLEN];
735 shutting_down = True;
737 if (protocol_version < 29)
740 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
741 if (protocol_version >= 31 && i == NDX_DONE) {
743 write_ndx(f_out, NDX_DONE);
745 if (batch_gen_fd >= 0) {
746 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
747 read_del_stats(batch_gen_fd);
749 write_int(f_out, NDX_DONE);
751 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
756 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
758 exit_cleanup(RERR_PROTOCOL);
762 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
764 struct file_list *flist;
767 if (DEBUG_GTE(SEND, 1)) {
768 rprintf(FINFO, "server_sender starting pid=%ld\n",
772 if (am_daemon && lp_write_only(module_id)) {
773 rprintf(FERROR, "ERROR: module is write only\n");
774 exit_cleanup(RERR_SYNTAX);
777 if (am_daemon && read_only && remove_source_files) {
779 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
780 remove_source_files == 1 ? "source" : "sent");
781 exit_cleanup(RERR_SYNTAX);
785 if (!relative_paths) {
786 if (!change_dir(dir, CD_NORMAL)) {
787 rsyserr(FERROR, errno, "change_dir#3 %s failed",
789 exit_cleanup(RERR_FILESELECT);
795 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
801 flist = send_file_list(f_out,argc,argv);
802 if (!flist || flist->used == 0)
805 io_start_buffering_in(f_in);
807 send_files(f_in, f_out);
808 io_flush(FULL_FLUSH);
810 if (protocol_version >= 24)
811 read_final_goodbye(f_in, f_out);
812 io_flush(FULL_FLUSH);
817 static int do_recv(int f_in, int f_out, char *local_name)
823 /* The receiving side mustn't obey this, or an existing symlink that
824 * points to an identical file won't be replaced by the referent. */
825 copy_links = copy_dirlinks = copy_unsafe_links = 0;
827 #ifdef SUPPORT_HARD_LINKS
828 if (preserve_hard_links && !inc_recurse)
829 match_hard_links(first_flist);
832 if (fd_pair(error_pipe) < 0) {
833 rsyserr(FERROR, errno, "pipe failed in do_recv");
834 exit_cleanup(RERR_IPC);
838 int ret = make_path(backup_dir_buf, MKP_DROP_NAME); /* drops trailing slash */
840 exit_cleanup(RERR_SYNTAX);
842 rprintf(FINFO, "Created backup_dir %s\n", backup_dir_buf);
843 else if (INFO_GTE(BACKUP, 1))
844 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
847 io_flush(FULL_FLUSH);
849 if ((pid = do_fork()) == -1) {
850 rsyserr(FERROR, errno, "fork failed in do_recv");
851 exit_cleanup(RERR_IPC);
856 send_msgs_to_gen = am_server;
858 close(error_pipe[0]);
860 /* We can't let two processes write to the socket at one time. */
861 io_end_multiplex_out(MPLX_SWITCHING);
865 f_out = error_pipe[1];
867 bwlimit_writemax = 0; /* receiver doesn't need to do this */
870 io_start_buffering_in(f_in);
871 io_start_multiplex_out(f_out);
873 recv_files(f_in, f_out, local_name);
874 io_flush(FULL_FLUSH);
877 if (output_needs_newline) {
879 output_needs_newline = 0;
882 write_int(f_out, NDX_DONE);
883 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
884 io_flush(FULL_FLUSH);
886 /* Handle any keep-alive packets from the post-processing work
887 * that the generator does. */
888 if (protocol_version >= 29) {
889 kluge_around_eof = -1;
891 /* This should only get stopped via a USR2 signal. */
892 read_final_goodbye(f_in, f_out);
894 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
896 exit_cleanup(RERR_PROTOCOL);
899 /* Finally, we go to sleep until our parent kills us with a
900 * USR2 signal. We sleep for a short time, as on some OSes
901 * a signal won't interrupt a sleep! */
907 flist_receiving_enabled = True;
909 io_end_multiplex_in(MPLX_SWITCHING);
910 if (write_batch && !am_server)
913 close(error_pipe[1]);
917 f_in = error_pipe[0];
919 io_start_buffering_out(f_out);
920 io_start_multiplex_in(f_in);
922 #ifdef SUPPORT_HARD_LINKS
923 if (preserve_hard_links && inc_recurse) {
924 struct file_list *flist;
925 for (flist = first_flist; flist; flist = flist->next)
926 match_hard_links(flist);
930 generate_files(f_out, local_name);
933 io_flush(FULL_FLUSH);
934 shutting_down = True;
935 if (protocol_version >= 24) {
936 /* send a final goodbye message */
937 write_ndx(f_out, NDX_DONE);
939 io_flush(FULL_FLUSH);
942 wait_process_with_flush(pid, &exit_code);
946 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
949 struct file_list *flist;
950 char *local_name = NULL;
953 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
954 /* We can't mix messages with files-from data on the socket,
955 * so temporarily turn off info/debug messages. */
956 negate_output_levels();
961 if (DEBUG_GTE(RECV, 1)) {
962 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
963 argc, (long)getpid());
966 if (am_daemon && read_only) {
967 rprintf(FERROR,"ERROR: module is read only\n");
968 exit_cleanup(RERR_SYNTAX);
976 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
977 rsyserr(FERROR, errno, "change_dir#4 %s failed",
979 exit_cleanup(RERR_FILESELECT);
983 if (protocol_version >= 30)
984 io_start_multiplex_in(f_in);
986 io_start_buffering_in(f_in);
987 recv_filter_list(f_in);
989 if (filesfrom_fd >= 0) {
990 /* We need to send the files-from names to the sender at the
991 * same time that we receive the file-list from them, so we
992 * need the IO routines to automatically write out the names
993 * onto our f_out socket as we read the file-list. This
994 * avoids both deadlock and extra delays/buffers. */
995 start_filesfrom_forwarding(filesfrom_fd);
999 flist = recv_file_list(f_in);
1001 rprintf(FERROR,"server_recv: recv_file_list error\n");
1002 exit_cleanup(RERR_FILESELECT);
1004 if (inc_recurse && file_total == 1)
1005 recv_additional_file_list(f_in);
1008 negate_output_levels();
1011 local_name = get_local_name(flist,argv[0]);
1013 /* Now that we know what our destination directory turned out to be,
1014 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1015 if (sanitize_paths) {
1017 for (dir_p = basis_dir; *dir_p; dir_p++)
1018 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1020 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1022 check_alt_basis_dirs();
1024 if (daemon_filter_list.head) {
1026 filter_rule_list *elp = &daemon_filter_list;
1028 for (dir_p = basis_dir; *dir_p; dir_p++) {
1031 dir += module_dirlen;
1032 if (check_filter(elp, FLOG, dir, 1) < 0)
1033 goto options_rejected;
1035 if (partial_dir && *partial_dir == '/'
1036 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1039 "Your options have been rejected by the server.\n");
1040 exit_cleanup(RERR_SYNTAX);
1044 exit_code = do_recv(f_in, f_out, local_name);
1045 exit_cleanup(exit_code);
1049 int child_main(int argc, char *argv[])
1051 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1056 void start_server(int f_in, int f_out, int argc, char *argv[])
1058 set_nonblocking(f_in);
1059 set_nonblocking(f_out);
1061 io_set_sock_fds(f_in, f_out);
1062 setup_protocol(f_out, f_in);
1064 if (protocol_version >= 23)
1065 io_start_multiplex_out(f_out);
1066 if (am_daemon && io_timeout && protocol_version >= 31)
1067 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1070 keep_dirlinks = 0; /* Must be disabled on the sender. */
1071 if (need_messages_from_generator)
1072 io_start_multiplex_in(f_in);
1074 io_start_buffering_in(f_in);
1075 recv_filter_list(f_in);
1076 do_server_sender(f_in, f_out, argc, argv);
1078 do_server_recv(f_in, f_out, argc, argv);
1082 /* This is called once the connection has been negotiated. It is used
1083 * for rsyncd, remote-shell, and local connections. */
1084 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1086 struct file_list *flist = NULL;
1087 int exit_code = 0, exit_code2 = 0;
1088 char *local_name = NULL;
1090 cleanup_child_pid = pid;
1092 set_nonblocking(f_in);
1093 set_nonblocking(f_out);
1096 io_set_sock_fds(f_in, f_out);
1097 setup_protocol(f_out,f_in);
1099 /* We set our stderr file handle to blocking because ssh might have
1100 * set it to non-blocking. This can be particularly troublesome if
1101 * stderr is a clone of stdout, because ssh would have set our stdout
1102 * to non-blocking at the same time (which can easily cause us to lose
1103 * output from our print statements). This kluge shouldn't cause ssh
1104 * any problems for how we use it. Note also that we delayed setting
1105 * this until after the above protocol setup so that we know for sure
1106 * that ssh is done twiddling its file descriptors. */
1107 set_blocking(STDERR_FILENO);
1110 keep_dirlinks = 0; /* Must be disabled on the sender. */
1113 && (log_format_has(stdout_format, 'C')
1114 || log_format_has(logfile_format, 'C')))
1115 sender_keeps_checksum = 1;
1117 if (protocol_version >= 30)
1118 io_start_multiplex_out(f_out);
1120 io_start_buffering_out(f_out);
1121 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1122 io_start_multiplex_in(f_in);
1124 io_start_buffering_in(f_in);
1125 send_filter_list(f_out);
1127 filesfrom_fd = f_in;
1129 if (write_batch && !am_server)
1130 start_write_batch(f_out);
1131 flist = send_file_list(f_out, argc, argv);
1132 if (DEBUG_GTE(FLIST, 3))
1133 rprintf(FINFO,"file list sent\n");
1135 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1136 io_start_multiplex_in(f_in);
1138 io_flush(NORMAL_FLUSH);
1139 send_files(f_in, f_out);
1140 io_flush(FULL_FLUSH);
1142 if (protocol_version >= 24)
1143 read_final_goodbye(f_in, f_out);
1145 if (DEBUG_GTE(EXIT, 2))
1146 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1147 io_flush(FULL_FLUSH);
1148 wait_process_with_flush(pid, &exit_code);
1151 io_flush(FULL_FLUSH);
1152 exit_cleanup(exit_code);
1156 if (protocol_version >= 23)
1157 io_start_multiplex_in(f_in);
1158 if (need_messages_from_generator)
1159 io_start_multiplex_out(f_out);
1161 io_start_buffering_out(f_out);
1164 send_filter_list(read_batch ? -1 : f_out);
1166 if (filesfrom_fd >= 0) {
1167 start_filesfrom_forwarding(filesfrom_fd);
1171 if (write_batch && !am_server)
1172 start_write_batch(f_in);
1173 flist = recv_file_list(f_in);
1174 if (inc_recurse && file_total == 1)
1175 recv_additional_file_list(f_in);
1177 if (flist && flist->used > 0) {
1178 local_name = get_local_name(flist, argv[0]);
1180 check_alt_basis_dirs();
1182 exit_code2 = do_recv(f_in, f_out, local_name);
1189 if (DEBUG_GTE(RECV, 1))
1190 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1191 io_flush(FULL_FLUSH);
1192 wait_process_with_flush(pid, &exit_code);
1195 return MAX(exit_code, exit_code2);
1198 static int copy_argv(char *argv[])
1202 for (i = 0; argv[i]; i++) {
1203 if (!(argv[i] = strdup(argv[i]))) {
1204 rprintf (FERROR, "out of memory at %s(%d)\n",
1205 __FILE__, __LINE__);
1214 /* Start a client for either type of remote connection. Work out
1215 * whether the arguments request a remote shell or rsyncd connection,
1216 * and call the appropriate connection function, then run_client.
1218 * Calls either start_socket_client (for sockets) or do_cmd and
1219 * client_run (for ssh). */
1220 static int start_client(int argc, char *argv[])
1222 char *p, *shell_machine = NULL, *shell_user = NULL;
1229 /* Don't clobber argv[] so that ps(1) can still show the right
1231 if ((ret = copy_argv(argv)) != 0)
1234 if (!read_batch) { /* for read_batch, NO source is specified */
1235 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1236 if (path) { /* source is remote */
1243 if (argc == 1 || **argv == ':')
1244 argc = 0; /* no dest arg */
1245 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1247 "The source and destination cannot both be remote.\n");
1248 exit_cleanup(RERR_SYNTAX);
1250 remote_argc--; /* don't count dest */
1253 if (filesfrom_host && *filesfrom_host
1254 && strcmp(filesfrom_host, shell_machine) != 0) {
1256 "--files-from hostname is not the same as the transfer hostname\n");
1257 exit_cleanup(RERR_SYNTAX);
1261 daemon_over_rsh = shell_cmd ? 1 : -1;
1262 } else { /* source is local, check dest arg */
1267 remote_argv = argv + argc;
1269 static char *dotarg[1] = { "." };
1271 remote_argv = dotarg;
1275 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1276 if (path && filesfrom_host && *filesfrom_host
1277 && strcmp(filesfrom_host, shell_machine) != 0) {
1279 "--files-from hostname is not the same as the transfer hostname\n");
1280 exit_cleanup(RERR_SYNTAX);
1282 if (!path) { /* no hostspec found, so src & dest are local */
1284 if (filesfrom_host) {
1286 "--files-from cannot be remote when the transfer is local\n");
1287 exit_cleanup(RERR_SYNTAX);
1289 shell_machine = NULL;
1290 } else { /* hostspec was found, so dest is remote */
1293 daemon_over_rsh = shell_cmd ? 1 : -1;
1296 } else { /* read_batch */
1298 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1299 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1300 exit_cleanup(RERR_SYNTAX);
1302 remote_argv = argv += argc - 1;
1303 remote_argc = argc = 1;
1308 int dummy_port = rsync_port;
1310 /* For local source, extra source args must not have hostspec. */
1311 for (i = 1; i < argc; i++) {
1312 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1313 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1314 exit_cleanup(RERR_SYNTAX);
1319 int dummy_port = rsync_port;
1321 /* For remote source, any extra source args must have either
1322 * the same hostname or an empty hostname. */
1323 for (i = 1; i < remote_argc; i++) {
1324 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1326 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1327 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1328 exit_cleanup(RERR_SYNTAX);
1330 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1331 rprintf(FERROR, "All source args must come from the same machine.\n");
1332 exit_cleanup(RERR_SYNTAX);
1334 if (rsync_port != dummy_port) {
1335 if (!rsync_port || !dummy_port)
1336 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1338 rprintf(FERROR, "All source args must use the same port number.\n");
1339 exit_cleanup(RERR_SYNTAX);
1341 remote_argv[i] = arg;
1345 if (daemon_over_rsh < 0)
1346 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1348 if (password_file && !daemon_over_rsh) {
1349 rprintf(FERROR, "The --password-file option may only be "
1350 "used when accessing an rsync daemon.\n");
1351 exit_cleanup(RERR_SYNTAX);
1354 if (connect_timeout) {
1355 rprintf(FERROR, "The --contimeout option may only be "
1356 "used when connecting to an rsync daemon.\n");
1357 exit_cleanup(RERR_SYNTAX);
1360 if (shell_machine) {
1361 p = strrchr(shell_machine,'@');
1364 shell_user = shell_machine;
1365 shell_machine = p+1;
1369 if (DEBUG_GTE(CMD, 2)) {
1370 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1371 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1372 NS(remote_argv[0]));
1375 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1378 /* if we're running an rsync server on the remote host over a
1379 * remote shell command, we need to do the RSYNCD protocol first */
1380 if (daemon_over_rsh) {
1382 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1387 ret = client_run(f_in, f_out, pid, argc, argv);
1396 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1398 exit_cleanup(RERR_SIGNAL1);
1401 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1407 _exit(RERR_PARTIAL);
1411 RETSIGTYPE remember_children(UNUSED(int val))
1416 /* An empty waitpid() loop was put here by Tridge and we could never
1417 * get him to explain why he put it in, so rather than taking it
1418 * out we're instead saving the child exit statuses for later use.
1419 * The waitpid() loop presumably eliminates all possibility of leaving
1420 * zombie children, maybe that's why he did it. */
1421 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1422 /* save the child's exit status */
1423 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1424 if (pid_stat_table[cnt].pid == 0) {
1425 pid_stat_table[cnt].pid = pid;
1426 pid_stat_table[cnt].status = status;
1432 #ifndef HAVE_SIGACTION
1433 signal(SIGCHLD, remember_children);
1439 * This routine catches signals and tries to send them to gdb.
1441 * Because it's called from inside a signal handler it ought not to
1442 * use too many library routines.
1444 * @todo Perhaps use "screen -X" instead/as well, to help people
1445 * debugging without easy access to X. Perhaps use an environment
1446 * variable, or just call a script?
1448 * @todo The /proc/ magic probably only works on Linux (and
1449 * Solaris?) Can we be more portable?
1451 #ifdef MAINTAINER_MODE
1452 const char *get_panic_action(void)
1454 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1459 return "xterm -display :0 -T Panic -n Panic "
1460 "-e gdb /proc/%d/exe %d";
1465 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1467 * This signal handler is only installed if we were configured with
1468 * --enable-maintainer-mode. Perhaps it should always be on and we
1469 * should just look at the environment variable, but I'm a bit leery
1470 * of a signal sending us into a busy loop.
1472 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1477 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1478 getpid(), getpid());
1480 /* Unless we failed to execute gdb, we allow the process to
1481 * continue. I'm not sure if that's right. */
1482 ret = system(cmd_buf);
1489 int main(int argc,char *argv[])
1492 int orig_argc = argc;
1493 char **orig_argv = argv;
1494 #ifdef HAVE_SIGACTION
1495 # ifdef HAVE_SIGPROCMASK
1498 sigemptyset(&sigmask);
1500 sigact.sa_flags = SA_NOCLDSTOP;
1502 SIGACTMASK(SIGUSR1, sigusr1_handler);
1503 SIGACTMASK(SIGUSR2, sigusr2_handler);
1504 SIGACTMASK(SIGCHLD, remember_children);
1505 #ifdef MAINTAINER_MODE
1506 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1507 SIGACTMASK(SIGFPE, rsync_panic_handler);
1508 SIGACTMASK(SIGABRT, rsync_panic_handler);
1509 SIGACTMASK(SIGBUS, rsync_panic_handler);
1512 starttime = time(NULL);
1515 am_root = our_uid == 0;
1517 memset(&stats, 0, sizeof(stats));
1521 exit_cleanup(RERR_SYNTAX);
1524 /* we set a 0 umask so that correct file permissions can be
1526 orig_umask = umask(0);
1528 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1529 setlocale(LC_CTYPE, "");
1532 if (!parse_arguments(&argc, (const char ***) &argv)) {
1533 /* FIXME: We ought to call the same error-handling
1534 * code here, rather than relying on getopt. */
1536 exit_cleanup(RERR_SYNTAX);
1539 SIGACTMASK(SIGINT, sig_int);
1540 SIGACTMASK(SIGHUP, sig_int);
1541 SIGACTMASK(SIGTERM, sig_int);
1542 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1543 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1546 /* Ignore SIGPIPE; we consistently check error codes and will
1548 SIGACTION(SIGPIPE, SIG_IGN);
1550 SIGACTION(SIGXFSZ, SIG_IGN);
1553 /* Initialize change_dir() here because on some old systems getcwd
1554 * (implemented by forking "pwd" and reading its output) doesn't
1555 * work when there are other child processes. Also, on all systems
1556 * that implement getcwd that way "pwd" can't be found after chroot. */
1557 change_dir(NULL, CD_NORMAL);
1561 if ((write_batch || read_batch) && !am_server) {
1563 write_batch_shell_file(orig_argc, orig_argv, argc);
1565 if (read_batch && strcmp(batch_name, "-") == 0)
1566 batch_fd = STDIN_FILENO;
1568 batch_fd = do_open(batch_name,
1569 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1570 : O_RDONLY, S_IRUSR | S_IWUSR);
1573 rsyserr(FERROR, errno, "Batch file %s open error",
1574 full_fname(batch_name));
1575 exit_cleanup(RERR_FILEIO);
1578 read_stream_flags(batch_fd);
1580 write_stream_flags(batch_fd);
1582 if (write_batch < 0)
1589 } else if (am_daemon)
1590 return daemon_main();
1592 if (am_server && protect_args) {
1593 char buf[MAXPATHLEN];
1595 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1596 if (!parse_arguments(&argc, (const char ***) &argv)) {
1598 exit_cleanup(RERR_SYNTAX);
1604 exit_cleanup(RERR_SYNTAX);
1608 set_nonblocking(STDIN_FILENO);
1609 set_nonblocking(STDOUT_FILENO);
1611 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1612 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1615 ret = start_client(argc, argv);
1617 exit_cleanup(RERR_STARTCLIENT);