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;
99 int daemon_over_rsh = 0;
100 mode_t orig_umask = 0;
101 int batch_gen_fd = -1;
102 int sender_keeps_checksum = 0;
104 /* There's probably never more than at most 2 outstanding child processes,
105 * but set it higher, just in case. */
106 #define MAXCHILDPROCS 7
108 #ifdef HAVE_SIGACTION
109 # ifdef HAVE_SIGPROCMASK
110 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
112 # define SIGACTMASK(n,h) SIGACTION(n,h)
114 static struct sigaction sigact;
120 } pid_stat_table[MAXCHILDPROCS];
122 static time_t starttime, endtime;
123 static int64 total_read, total_written;
125 static void show_malloc_stats(void);
127 /* Works like waitpid(), but if we already harvested the child pid in our
128 * remember_children(), we succeed instead of returning an error. */
129 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
134 waited_pid = waitpid(pid, status_ptr, flags);
135 } while (waited_pid == -1 && errno == EINTR);
137 if (waited_pid == -1 && errno == ECHILD) {
138 /* Status of requested child no longer available: check to
139 * see if it was processed by remember_children(). */
141 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
142 if (pid == pid_stat_table[cnt].pid) {
143 *status_ptr = pid_stat_table[cnt].status;
144 pid_stat_table[cnt].pid = 0;
153 /* Wait for a process to exit, calling io_flush while waiting. */
154 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
159 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
161 io_flush(FULL_FLUSH);
164 /* TODO: If the child exited on a signal, then log an
165 * appropriate error message. Perhaps we should also accept a
166 * message describing the purpose of the child. Also indicate
167 * this to the caller so that they know something went wrong. */
168 if (waited_pid < 0) {
169 rsyserr(FERROR, errno, "waitpid");
170 *exit_code_ptr = RERR_WAITCHILD;
171 } else if (!WIFEXITED(status)) {
173 if (WCOREDUMP(status))
174 *exit_code_ptr = RERR_CRASHED;
177 if (WIFSIGNALED(status))
178 *exit_code_ptr = RERR_TERMINATED;
180 *exit_code_ptr = RERR_WAITCHILD;
182 *exit_code_ptr = WEXITSTATUS(status);
185 void write_del_stats(int f)
188 write_int(f, NDX_DEL_STATS);
190 write_ndx(f, NDX_DEL_STATS);
191 write_varint(f, stats.deleted_files - stats.deleted_dirs
192 - stats.deleted_symlinks - stats.deleted_devices
193 - stats.deleted_specials);
194 write_varint(f, stats.deleted_dirs);
195 write_varint(f, stats.deleted_symlinks);
196 write_varint(f, stats.deleted_devices);
197 write_varint(f, stats.deleted_specials);
200 void read_del_stats(int f)
202 stats.deleted_files = read_varint(f);
203 stats.deleted_files += stats.deleted_dirs = read_varint(f);
204 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
205 stats.deleted_files += stats.deleted_devices = read_varint(f);
206 stats.deleted_files += stats.deleted_specials = read_varint(f);
209 /* This function gets called from all 3 processes. We want the client side
210 * to actually output the text, but the sender is the only process that has
211 * all the stats we need. So, if we're a client sender, we do the report.
212 * If we're a server sender, we write the stats on the supplied fd. If
213 * we're the client receiver we read the stats from the supplied fd and do
214 * the report. All processes might also generate a set of debug stats, if
215 * the verbose level is high enough (this is the only thing that the
216 * generator process and the server receiver ever do here). */
217 static void handle_stats(int f)
219 endtime = time(NULL);
221 /* Cache two stats because the read/write code can change it. */
222 total_read = stats.total_read;
223 total_written = stats.total_written;
225 if (INFO_GTE(STATS, 3)) {
226 /* These come out from every process */
235 if (f == -1 || !am_sender)
241 write_varlong30(f, total_read, 3);
242 write_varlong30(f, total_written, 3);
243 write_varlong30(f, stats.total_size, 3);
244 if (protocol_version >= 29) {
245 write_varlong30(f, stats.flist_buildtime, 3);
246 write_varlong30(f, stats.flist_xfertime, 3);
252 /* this is the client */
254 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
256 else if (!am_sender) {
257 /* Read the first two in opposite order because the meaning of
258 * read/write swaps when switching from sender to receiver. */
259 total_written = read_varlong30(f, 3);
260 total_read = read_varlong30(f, 3);
261 stats.total_size = read_varlong30(f, 3);
262 if (protocol_version >= 29) {
263 stats.flist_buildtime = read_varlong30(f, 3);
264 stats.flist_xfertime = read_varlong30(f, 3);
266 } else if (write_batch) {
267 /* The --read-batch process is going to be a client
268 * receiver, so we need to give it the stats. */
269 write_varlong30(batch_fd, total_read, 3);
270 write_varlong30(batch_fd, total_written, 3);
271 write_varlong30(batch_fd, stats.total_size, 3);
272 if (protocol_version >= 29) {
273 write_varlong30(batch_fd, stats.flist_buildtime, 3);
274 write_varlong30(batch_fd, stats.flist_xfertime, 3);
279 static void output_itemized_counts(const char *prefix, int *counts)
281 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
282 char buf[1024], *pre = " (";
284 int total = counts[0];
286 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
287 for (j = 0; j < 5; j++) {
289 len += snprintf(buf+len, sizeof buf - len - 2,
291 pre, labels[j], comma_num(counts[j]));
298 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
301 static void output_summary(void)
303 if (INFO_GTE(STATS, 2)) {
304 rprintf(FCLIENT, "\n");
305 output_itemized_counts("Number of files", &stats.num_files);
306 if (protocol_version >= 29)
307 output_itemized_counts("Number of created files", &stats.created_files);
308 if (protocol_version >= 31)
309 output_itemized_counts("Number of deleted files", &stats.deleted_files);
310 rprintf(FINFO,"Number of regular files transferred: %s\n",
311 comma_num(stats.xferred_files));
312 rprintf(FINFO,"Total file size: %s bytes\n",
313 human_num(stats.total_size));
314 rprintf(FINFO,"Total transferred file size: %s bytes\n",
315 human_num(stats.total_transferred_size));
316 rprintf(FINFO,"Literal data: %s bytes\n",
317 human_num(stats.literal_data));
318 rprintf(FINFO,"Matched data: %s bytes\n",
319 human_num(stats.matched_data));
320 rprintf(FINFO,"File list size: %s\n",
321 human_num(stats.flist_size));
322 if (stats.flist_buildtime) {
324 "File list generation time: %s seconds\n",
325 comma_dnum((double)stats.flist_buildtime / 1000, 3));
327 "File list transfer time: %s seconds\n",
328 comma_dnum((double)stats.flist_xfertime / 1000, 3));
330 rprintf(FINFO,"Total bytes sent: %s\n",
331 human_num(total_written));
332 rprintf(FINFO,"Total bytes received: %s\n",
333 human_num(total_read));
336 if (INFO_GTE(STATS, 1)) {
337 rprintf(FCLIENT, "\n");
339 "sent %s bytes received %s bytes %s bytes/sec\n",
340 human_num(total_written), human_num(total_read),
341 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
342 rprintf(FINFO, "total size is %s speedup is %s%s\n",
343 human_num(stats.total_size),
344 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
345 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
354 * If our C library can get malloc statistics, then show them to FINFO
356 static void show_malloc_stats(void)
363 rprintf(FCLIENT, "\n");
364 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
365 getpid(), am_server ? "server " : "",
366 am_daemon ? "daemon " : "", who_am_i());
367 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
369 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
371 rprintf(FINFO, " smblks: %10ld\n",
373 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
375 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
377 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
378 (long)mi.arena + mi.hblkhd);
379 rprintf(FINFO, " usmblks: %10ld\n",
381 rprintf(FINFO, " fsmblks: %10ld\n",
383 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
385 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
387 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
389 #endif /* HAVE_MALLINFO */
393 /* Start the remote shell. cmd may be NULL to use the default. */
394 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
395 int *f_in_p, int *f_out_p)
398 char *args[MAX_ARGS];
402 if (!read_batch && !local_server) {
403 char *t, *f, in_quote = '\0';
404 char *rsh_env = getenv(RSYNC_RSH_ENV);
409 cmd = strdup(cmd); /*MEMORY LEAK*/
413 for (t = f = cmd; *f; f++) {
416 /* Comparison leaves rooms for server_options(). */
417 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
420 while (*f != ' ' || in_quote) {
424 "Missing trailing-%c in remote-shell command.\n",
426 exit_cleanup(RERR_SYNTAX);
431 if (*f == '\'' || *f == '"') {
436 if (*f == in_quote && *++f != in_quote) {
446 /* check to see if we've already been given '-l user' in
447 * the remote-shell command */
448 for (i = 0; i < argc-1; i++) {
449 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
454 /* remsh (on HPUX) takes the arguments the other way around */
455 args[argc++] = machine;
456 if (user && !(daemon_over_rsh && dash_l_set)) {
461 if (user && !(daemon_over_rsh && dash_l_set)) {
465 args[argc++] = machine;
468 args[argc++] = rsync_path;
470 if (blocking_io < 0) {
472 if ((cp = strrchr(cmd, '/')) != NULL)
476 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
480 server_options(args,&argc);
482 if (argc >= MAX_ARGS - 2)
488 if (!daemon_over_rsh) {
489 while (remote_argc > 0) {
490 if (argc >= MAX_ARGS - 1) {
492 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
493 exit_cleanup(RERR_SYNTAX);
495 args[argc++] = *remote_argv++;
502 if (DEBUG_GTE(CMD, 2)) {
503 for (i = 0; i < argc; i++)
504 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
505 rprintf(FCLIENT, "\n");
509 int from_gen_pipe[2];
510 set_allow_inc_recurse();
511 if (fd_pair(from_gen_pipe) < 0) {
512 rsyserr(FERROR, errno, "pipe");
513 exit_cleanup(RERR_IPC);
515 batch_gen_fd = from_gen_pipe[0];
516 *f_out_p = from_gen_pipe[1];
518 pid = (pid_t)-1; /* no child pid */
522 } else if (local_server) {
523 /* If the user didn't request --[no-]whole-file, force
524 * it on, but only if we're not batch processing. */
525 if (whole_file < 0 && !write_batch)
527 set_allow_inc_recurse();
528 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
533 pid = piped_child(args, f_in_p, f_out_p);
537 if (protect_args && !daemon_over_rsh)
538 send_protected_args(*f_out_p, args);
544 out_of_memory("do_cmd");
545 return 0; /* not reached */
548 /* The receiving side operates in one of two modes:
550 * 1. it receives any number of files into a destination directory,
551 * placing them according to their names in the file-list.
553 * 2. it receives a single file and saves it using the name in the
554 * destination path instead of its file-list name. This requires a
555 * "local name" for writing out the destination file.
557 * So, our task is to figure out what mode/local-name we need.
558 * For mode 1, we change into the destination directory and return NULL.
559 * For mode 2, we change into the directory containing the destination
560 * file (if we aren't already there) and return the local-name. */
561 static char *get_local_name(struct file_list *flist, char *dest_path)
567 if (DEBUG_GTE(RECV, 1)) {
568 rprintf(FINFO, "get_local_name count=%d %s\n",
569 file_total, NS(dest_path));
572 if (!dest_path || list_only)
575 if (daemon_filter_list.head) {
576 char *slash = strrchr(dest_path, '/');
577 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
581 if ((*dest_path != '.' || dest_path[1] != '\0')
582 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
583 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
584 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
586 exit_cleanup(RERR_FILESELECT);
592 /* See what currently exists at the destination. */
593 if ((statret = do_stat(dest_path, &st)) == 0) {
594 /* If the destination is a dir, enter it and use mode 1. */
595 if (S_ISDIR(st.st_mode)) {
596 if (!change_dir(dest_path, CD_NORMAL)) {
597 rsyserr(FERROR, errno, "change_dir#1 %s failed",
598 full_fname(dest_path));
599 exit_cleanup(RERR_FILESELECT);
603 if (file_total > 1) {
605 "ERROR: destination must be a directory when"
606 " copying more than 1 file\n");
607 exit_cleanup(RERR_FILESELECT);
609 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
611 "ERROR: cannot overwrite non-directory"
612 " with a directory\n");
613 exit_cleanup(RERR_FILESELECT);
615 } else if (errno != ENOENT) {
616 /* If we don't know what's at the destination, fail. */
617 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
618 full_fname(dest_path));
619 exit_cleanup(RERR_FILESELECT);
622 cp = strrchr(dest_path, '/');
624 /* If we need a destination directory because the transfer is not
625 * of a single non-directory or the user has requested one via a
626 * destination path ending in a slash, create one and use mode 1. */
627 if (file_total > 1 || (cp && !cp[1])) {
628 /* Lop off the final slash (if any). */
634 "ERROR: destination path is not a directory\n");
635 exit_cleanup(RERR_SYNTAX);
638 if (mkdir_defmode(dest_path) != 0) {
639 rsyserr(FERROR, errno, "mkdir %s failed",
640 full_fname(dest_path));
641 exit_cleanup(RERR_FILEIO);
644 if (flist->high >= flist->low
645 && strcmp(flist->files[flist->low]->basename, ".") == 0)
646 flist->files[0]->flags |= FLAG_DIR_CREATED;
648 if (INFO_GTE(NAME, 1))
649 rprintf(FINFO, "created directory %s\n", dest_path);
652 /* Indicate that dest dir doesn't really exist. */
656 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
657 rsyserr(FERROR, errno, "change_dir#2 %s failed",
658 full_fname(dest_path));
659 exit_cleanup(RERR_FILESELECT);
665 /* Otherwise, we are writing a single file, possibly on top of an
666 * existing non-directory. Change to the item's parent directory
667 * (if it has a path component), return the basename of the
668 * destination file as the local name, and use mode 2. */
676 if (!change_dir(dest_path, CD_NORMAL)) {
677 rsyserr(FERROR, errno, "change_dir#3 %s failed",
678 full_fname(dest_path));
679 exit_cleanup(RERR_FILESELECT);
686 /* This function checks on our alternate-basis directories. If we're in
687 * dry-run mode and the destination dir does not yet exist, we'll try to
688 * tweak any dest-relative paths to make them work for a dry-run (the
689 * destination dir must be in curr_dir[] when this function is called).
690 * We also warn about any arg that is non-existent or not a directory. */
691 static void check_alt_basis_dirs(void)
694 char **dir_p, *slash = strrchr(curr_dir, '/');
696 for (dir_p = basis_dir; *dir_p; dir_p++) {
697 if (dry_run > 1 && **dir_p != '/') {
698 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
699 char *new = new_array(char, len);
701 out_of_memory("check_alt_basis_dirs");
702 if (slash && strncmp(*dir_p, "../", 3) == 0) {
703 /* We want to remove only one leading "../" prefix for
704 * the directory we couldn't create in dry-run mode:
705 * this ensures that any other ".." references get
706 * evaluated the same as they would for a live copy. */
708 pathjoin(new, len, curr_dir, *dir_p + 3);
711 pathjoin(new, len, curr_dir, *dir_p);
714 if (do_stat(*dir_p, &st) < 0) {
715 rprintf(FWARNING, "%s arg does not exist: %s\n",
716 dest_option, *dir_p);
717 } else if (!S_ISDIR(st.st_mode)) {
718 rprintf(FWARNING, "%s arg is not a dir: %s\n",
719 dest_option, *dir_p);
724 /* This is only called by the sender. */
725 static void read_final_goodbye(int f_in, int f_out)
729 char xname[MAXPATHLEN];
731 shutting_down = True;
733 if (protocol_version < 29)
736 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
737 if (protocol_version >= 31 && i == NDX_DONE) {
739 write_ndx(f_out, NDX_DONE);
741 if (batch_gen_fd >= 0) {
742 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
743 read_del_stats(batch_gen_fd);
745 write_int(f_out, NDX_DONE);
747 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
752 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
754 exit_cleanup(RERR_PROTOCOL);
758 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
760 struct file_list *flist;
763 if (DEBUG_GTE(SEND, 1)) {
764 rprintf(FINFO, "server_sender starting pid=%ld\n",
768 if (am_daemon && lp_write_only(module_id)) {
769 rprintf(FERROR, "ERROR: module is write only\n");
770 exit_cleanup(RERR_SYNTAX);
773 if (am_daemon && read_only && remove_source_files) {
775 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
776 remove_source_files == 1 ? "source" : "sent");
777 exit_cleanup(RERR_SYNTAX);
781 if (!relative_paths) {
782 if (!change_dir(dir, CD_NORMAL)) {
783 rsyserr(FERROR, errno, "change_dir#3 %s failed",
785 exit_cleanup(RERR_FILESELECT);
791 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
797 flist = send_file_list(f_out,argc,argv);
798 if (!flist || flist->used == 0)
801 io_start_buffering_in(f_in);
803 send_files(f_in, f_out);
804 io_flush(FULL_FLUSH);
806 if (protocol_version >= 24)
807 read_final_goodbye(f_in, f_out);
808 io_flush(FULL_FLUSH);
813 static int do_recv(int f_in, int f_out, char *local_name)
819 /* The receiving side mustn't obey this, or an existing symlink that
820 * points to an identical file won't be replaced by the referent. */
821 copy_links = copy_dirlinks = copy_unsafe_links = 0;
823 #ifdef SUPPORT_HARD_LINKS
824 if (preserve_hard_links && !inc_recurse)
825 match_hard_links(first_flist);
828 if (fd_pair(error_pipe) < 0) {
829 rsyserr(FERROR, errno, "pipe failed in do_recv");
830 exit_cleanup(RERR_IPC);
834 int ret = make_path(backup_dir_buf, MKP_DROP_NAME); /* drops trailing slash */
836 exit_cleanup(RERR_SYNTAX);
838 rprintf(FINFO, "Created backup_dir %s\n", backup_dir_buf);
839 else if (INFO_GTE(BACKUP, 1))
840 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
843 io_flush(FULL_FLUSH);
845 if ((pid = do_fork()) == -1) {
846 rsyserr(FERROR, errno, "fork failed in do_recv");
847 exit_cleanup(RERR_IPC);
851 send_msgs_to_gen = am_server;
853 close(error_pipe[0]);
855 /* We can't let two processes write to the socket at one time. */
856 io_end_multiplex_out(MPLX_SWITCHING);
860 f_out = error_pipe[1];
862 bwlimit_writemax = 0; /* receiver doesn't need to do this */
865 io_start_buffering_in(f_in);
866 io_start_multiplex_out(f_out);
868 recv_files(f_in, f_out, local_name);
869 io_flush(FULL_FLUSH);
872 if (output_needs_newline) {
874 output_needs_newline = 0;
877 write_int(f_out, NDX_DONE);
878 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
879 io_flush(FULL_FLUSH);
881 /* Handle any keep-alive packets from the post-processing work
882 * that the generator does. */
883 if (protocol_version >= 29) {
884 kluge_around_eof = -1;
886 /* This should only get stopped via a USR2 signal. */
887 read_final_goodbye(f_in, f_out);
889 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
891 exit_cleanup(RERR_PROTOCOL);
894 /* Finally, we go to sleep until our parent kills us with a
895 * USR2 signal. We sleep for a short time, as on some OSes
896 * a signal won't interrupt a sleep! */
902 flist_receiving_enabled = True;
904 io_end_multiplex_in(MPLX_SWITCHING);
905 if (write_batch && !am_server)
908 close(error_pipe[1]);
912 f_in = error_pipe[0];
914 io_start_buffering_out(f_out);
915 io_start_multiplex_in(f_in);
917 #ifdef SUPPORT_HARD_LINKS
918 if (preserve_hard_links && inc_recurse) {
919 struct file_list *flist;
920 for (flist = first_flist; flist; flist = flist->next)
921 match_hard_links(flist);
925 generate_files(f_out, local_name);
928 io_flush(FULL_FLUSH);
929 shutting_down = True;
930 if (protocol_version >= 24) {
931 /* send a final goodbye message */
932 write_ndx(f_out, NDX_DONE);
934 io_flush(FULL_FLUSH);
937 wait_process_with_flush(pid, &exit_code);
941 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
944 struct file_list *flist;
945 char *local_name = NULL;
948 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
949 /* We can't mix messages with files-from data on the socket,
950 * so temporarily turn off info/debug messages. */
951 negate_output_levels();
956 if (DEBUG_GTE(RECV, 1)) {
957 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
958 argc, (long)getpid());
961 if (am_daemon && read_only) {
962 rprintf(FERROR,"ERROR: module is read only\n");
963 exit_cleanup(RERR_SYNTAX);
971 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
972 rsyserr(FERROR, errno, "change_dir#4 %s failed",
974 exit_cleanup(RERR_FILESELECT);
978 if (protocol_version >= 30)
979 io_start_multiplex_in(f_in);
981 io_start_buffering_in(f_in);
982 recv_filter_list(f_in);
984 if (filesfrom_fd >= 0) {
985 /* We need to send the files-from names to the sender at the
986 * same time that we receive the file-list from them, so we
987 * need the IO routines to automatically write out the names
988 * onto our f_out socket as we read the file-list. This
989 * avoids both deadlock and extra delays/buffers. */
990 start_filesfrom_forwarding(filesfrom_fd);
994 flist = recv_file_list(f_in);
996 rprintf(FERROR,"server_recv: recv_file_list error\n");
997 exit_cleanup(RERR_FILESELECT);
999 if (inc_recurse && file_total == 1)
1000 recv_additional_file_list(f_in);
1003 negate_output_levels();
1006 local_name = get_local_name(flist,argv[0]);
1008 /* Now that we know what our destination directory turned out to be,
1009 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1010 if (sanitize_paths) {
1012 for (dir_p = basis_dir; *dir_p; dir_p++)
1013 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1015 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1017 check_alt_basis_dirs();
1019 if (daemon_filter_list.head) {
1021 filter_rule_list *elp = &daemon_filter_list;
1023 for (dir_p = basis_dir; *dir_p; dir_p++) {
1026 dir += module_dirlen;
1027 if (check_filter(elp, FLOG, dir, 1) < 0)
1028 goto options_rejected;
1030 if (partial_dir && *partial_dir == '/'
1031 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1034 "Your options have been rejected by the server.\n");
1035 exit_cleanup(RERR_SYNTAX);
1039 exit_code = do_recv(f_in, f_out, local_name);
1040 exit_cleanup(exit_code);
1044 int child_main(int argc, char *argv[])
1046 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1051 void start_server(int f_in, int f_out, int argc, char *argv[])
1053 set_nonblocking(f_in);
1054 set_nonblocking(f_out);
1056 io_set_sock_fds(f_in, f_out);
1057 setup_protocol(f_out, f_in);
1059 if (protocol_version >= 23)
1060 io_start_multiplex_out(f_out);
1061 if (am_daemon && io_timeout && protocol_version >= 31)
1062 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1065 keep_dirlinks = 0; /* Must be disabled on the sender. */
1066 if (need_messages_from_generator)
1067 io_start_multiplex_in(f_in);
1069 io_start_buffering_in(f_in);
1070 recv_filter_list(f_in);
1071 do_server_sender(f_in, f_out, argc, argv);
1073 do_server_recv(f_in, f_out, argc, argv);
1077 /* This is called once the connection has been negotiated. It is used
1078 * for rsyncd, remote-shell, and local connections. */
1079 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1081 struct file_list *flist = NULL;
1082 int exit_code = 0, exit_code2 = 0;
1083 char *local_name = NULL;
1085 cleanup_child_pid = pid;
1087 set_nonblocking(f_in);
1088 set_nonblocking(f_out);
1091 io_set_sock_fds(f_in, f_out);
1092 setup_protocol(f_out,f_in);
1094 /* We set our stderr file handle to blocking because ssh might have
1095 * set it to non-blocking. This can be particularly troublesome if
1096 * stderr is a clone of stdout, because ssh would have set our stdout
1097 * to non-blocking at the same time (which can easily cause us to lose
1098 * output from our print statements). This kluge shouldn't cause ssh
1099 * any problems for how we use it. Note also that we delayed setting
1100 * this until after the above protocol setup so that we know for sure
1101 * that ssh is done twiddling its file descriptors. */
1102 set_blocking(STDERR_FILENO);
1105 keep_dirlinks = 0; /* Must be disabled on the sender. */
1108 && (log_format_has(stdout_format, 'C')
1109 || log_format_has(logfile_format, 'C')))
1110 sender_keeps_checksum = 1;
1112 if (protocol_version >= 30)
1113 io_start_multiplex_out(f_out);
1115 io_start_buffering_out(f_out);
1116 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1117 io_start_multiplex_in(f_in);
1119 io_start_buffering_in(f_in);
1120 send_filter_list(f_out);
1122 filesfrom_fd = f_in;
1124 if (write_batch && !am_server)
1125 start_write_batch(f_out);
1126 flist = send_file_list(f_out, argc, argv);
1127 if (DEBUG_GTE(FLIST, 3))
1128 rprintf(FINFO,"file list sent\n");
1130 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1131 io_start_multiplex_in(f_in);
1133 io_flush(NORMAL_FLUSH);
1134 send_files(f_in, f_out);
1135 io_flush(FULL_FLUSH);
1137 if (protocol_version >= 24)
1138 read_final_goodbye(f_in, f_out);
1140 if (DEBUG_GTE(EXIT, 2))
1141 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1142 io_flush(FULL_FLUSH);
1143 wait_process_with_flush(pid, &exit_code);
1146 io_flush(FULL_FLUSH);
1147 exit_cleanup(exit_code);
1151 if (protocol_version >= 23)
1152 io_start_multiplex_in(f_in);
1153 if (need_messages_from_generator)
1154 io_start_multiplex_out(f_out);
1156 io_start_buffering_out(f_out);
1159 send_filter_list(read_batch ? -1 : f_out);
1161 if (filesfrom_fd >= 0) {
1162 start_filesfrom_forwarding(filesfrom_fd);
1166 if (write_batch && !am_server)
1167 start_write_batch(f_in);
1168 flist = recv_file_list(f_in);
1169 if (inc_recurse && file_total == 1)
1170 recv_additional_file_list(f_in);
1172 if (flist && flist->used > 0) {
1173 local_name = get_local_name(flist, argv[0]);
1175 check_alt_basis_dirs();
1177 exit_code2 = do_recv(f_in, f_out, local_name);
1184 if (DEBUG_GTE(RECV, 1))
1185 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1186 io_flush(FULL_FLUSH);
1187 wait_process_with_flush(pid, &exit_code);
1190 return MAX(exit_code, exit_code2);
1193 static int copy_argv(char *argv[])
1197 for (i = 0; argv[i]; i++) {
1198 if (!(argv[i] = strdup(argv[i]))) {
1199 rprintf (FERROR, "out of memory at %s(%d)\n",
1200 __FILE__, __LINE__);
1209 /* Start a client for either type of remote connection. Work out
1210 * whether the arguments request a remote shell or rsyncd connection,
1211 * and call the appropriate connection function, then run_client.
1213 * Calls either start_socket_client (for sockets) or do_cmd and
1214 * client_run (for ssh). */
1215 static int start_client(int argc, char *argv[])
1217 char *p, *shell_machine = NULL, *shell_user = NULL;
1224 /* Don't clobber argv[] so that ps(1) can still show the right
1226 if ((ret = copy_argv(argv)) != 0)
1229 if (!read_batch) { /* for read_batch, NO source is specified */
1230 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1231 if (path) { /* source is remote */
1238 if (argc == 1 || **argv == ':')
1239 argc = 0; /* no dest arg */
1240 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1242 "The source and destination cannot both be remote.\n");
1243 exit_cleanup(RERR_SYNTAX);
1245 remote_argc--; /* don't count dest */
1248 if (filesfrom_host && *filesfrom_host
1249 && strcmp(filesfrom_host, shell_machine) != 0) {
1251 "--files-from hostname is not the same as the transfer hostname\n");
1252 exit_cleanup(RERR_SYNTAX);
1256 daemon_over_rsh = shell_cmd ? 1 : -1;
1257 } else { /* source is local, check dest arg */
1262 remote_argv = argv + argc;
1264 static char *dotarg[1] = { "." };
1266 remote_argv = dotarg;
1270 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1271 if (path && filesfrom_host && *filesfrom_host
1272 && strcmp(filesfrom_host, shell_machine) != 0) {
1274 "--files-from hostname is not the same as the transfer hostname\n");
1275 exit_cleanup(RERR_SYNTAX);
1277 if (!path) { /* no hostspec found, so src & dest are local */
1279 if (filesfrom_host) {
1281 "--files-from cannot be remote when the transfer is local\n");
1282 exit_cleanup(RERR_SYNTAX);
1284 shell_machine = NULL;
1285 } else { /* hostspec was found, so dest is remote */
1288 daemon_over_rsh = shell_cmd ? 1 : -1;
1291 } else { /* read_batch */
1293 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1294 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1295 exit_cleanup(RERR_SYNTAX);
1297 remote_argv = argv += argc - 1;
1298 remote_argc = argc = 1;
1303 int dummy_port = rsync_port;
1305 /* For local source, extra source args must not have hostspec. */
1306 for (i = 1; i < argc; i++) {
1307 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1308 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1309 exit_cleanup(RERR_SYNTAX);
1314 int dummy_port = rsync_port;
1316 /* For remote source, any extra source args must have either
1317 * the same hostname or an empty hostname. */
1318 for (i = 1; i < remote_argc; i++) {
1319 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1321 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1322 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1323 exit_cleanup(RERR_SYNTAX);
1325 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1326 rprintf(FERROR, "All source args must come from the same machine.\n");
1327 exit_cleanup(RERR_SYNTAX);
1329 if (rsync_port != dummy_port) {
1330 if (!rsync_port || !dummy_port)
1331 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1333 rprintf(FERROR, "All source args must use the same port number.\n");
1334 exit_cleanup(RERR_SYNTAX);
1336 remote_argv[i] = arg;
1340 if (daemon_over_rsh < 0)
1341 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1343 if (password_file && !daemon_over_rsh) {
1344 rprintf(FERROR, "The --password-file option may only be "
1345 "used when accessing an rsync daemon.\n");
1346 exit_cleanup(RERR_SYNTAX);
1349 if (connect_timeout) {
1350 rprintf(FERROR, "The --contimeout option may only be "
1351 "used when connecting to an rsync daemon.\n");
1352 exit_cleanup(RERR_SYNTAX);
1355 if (shell_machine) {
1356 p = strrchr(shell_machine,'@');
1359 shell_user = shell_machine;
1360 shell_machine = p+1;
1364 if (DEBUG_GTE(CMD, 2)) {
1365 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1366 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1367 NS(remote_argv[0]));
1370 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1373 /* if we're running an rsync server on the remote host over a
1374 * remote shell command, we need to do the RSYNCD protocol first */
1375 if (daemon_over_rsh) {
1377 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1382 ret = client_run(f_in, f_out, pid, argc, argv);
1391 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1393 exit_cleanup(RERR_SIGNAL1);
1396 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1402 _exit(RERR_PARTIAL);
1406 RETSIGTYPE remember_children(UNUSED(int val))
1411 /* An empty waitpid() loop was put here by Tridge and we could never
1412 * get him to explain why he put it in, so rather than taking it
1413 * out we're instead saving the child exit statuses for later use.
1414 * The waitpid() loop presumably eliminates all possibility of leaving
1415 * zombie children, maybe that's why he did it. */
1416 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1417 /* save the child's exit status */
1418 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1419 if (pid_stat_table[cnt].pid == 0) {
1420 pid_stat_table[cnt].pid = pid;
1421 pid_stat_table[cnt].status = status;
1427 #ifndef HAVE_SIGACTION
1428 signal(SIGCHLD, remember_children);
1434 * This routine catches signals and tries to send them to gdb.
1436 * Because it's called from inside a signal handler it ought not to
1437 * use too many library routines.
1439 * @todo Perhaps use "screen -X" instead/as well, to help people
1440 * debugging without easy access to X. Perhaps use an environment
1441 * variable, or just call a script?
1443 * @todo The /proc/ magic probably only works on Linux (and
1444 * Solaris?) Can we be more portable?
1446 #ifdef MAINTAINER_MODE
1447 const char *get_panic_action(void)
1449 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1454 return "xterm -display :0 -T Panic -n Panic "
1455 "-e gdb /proc/%d/exe %d";
1460 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1462 * This signal handler is only installed if we were configured with
1463 * --enable-maintainer-mode. Perhaps it should always be on and we
1464 * should just look at the environment variable, but I'm a bit leery
1465 * of a signal sending us into a busy loop.
1467 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1472 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1473 getpid(), getpid());
1475 /* Unless we failed to execute gdb, we allow the process to
1476 * continue. I'm not sure if that's right. */
1477 ret = system(cmd_buf);
1484 int main(int argc,char *argv[])
1487 int orig_argc = argc;
1488 char **orig_argv = argv;
1489 #ifdef HAVE_SIGACTION
1490 # ifdef HAVE_SIGPROCMASK
1493 sigemptyset(&sigmask);
1495 sigact.sa_flags = SA_NOCLDSTOP;
1497 SIGACTMASK(SIGUSR1, sigusr1_handler);
1498 SIGACTMASK(SIGUSR2, sigusr2_handler);
1499 SIGACTMASK(SIGCHLD, remember_children);
1500 #ifdef MAINTAINER_MODE
1501 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1502 SIGACTMASK(SIGFPE, rsync_panic_handler);
1503 SIGACTMASK(SIGABRT, rsync_panic_handler);
1504 SIGACTMASK(SIGBUS, rsync_panic_handler);
1507 starttime = time(NULL);
1510 am_root = our_uid == 0;
1512 memset(&stats, 0, sizeof(stats));
1516 exit_cleanup(RERR_SYNTAX);
1519 /* we set a 0 umask so that correct file permissions can be
1521 orig_umask = umask(0);
1523 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1524 setlocale(LC_CTYPE, "");
1527 if (!parse_arguments(&argc, (const char ***) &argv)) {
1528 /* FIXME: We ought to call the same error-handling
1529 * code here, rather than relying on getopt. */
1531 exit_cleanup(RERR_SYNTAX);
1534 SIGACTMASK(SIGINT, sig_int);
1535 SIGACTMASK(SIGHUP, sig_int);
1536 SIGACTMASK(SIGTERM, sig_int);
1537 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1538 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1541 /* Ignore SIGPIPE; we consistently check error codes and will
1543 SIGACTION(SIGPIPE, SIG_IGN);
1545 SIGACTION(SIGXFSZ, SIG_IGN);
1548 /* Initialize change_dir() here because on some old systems getcwd
1549 * (implemented by forking "pwd" and reading its output) doesn't
1550 * work when there are other child processes. Also, on all systems
1551 * that implement getcwd that way "pwd" can't be found after chroot. */
1552 change_dir(NULL, CD_NORMAL);
1556 if ((write_batch || read_batch) && !am_server) {
1558 write_batch_shell_file(orig_argc, orig_argv, argc);
1560 if (read_batch && strcmp(batch_name, "-") == 0)
1561 batch_fd = STDIN_FILENO;
1563 batch_fd = do_open(batch_name,
1564 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1565 : O_RDONLY, S_IRUSR | S_IWUSR);
1568 rsyserr(FERROR, errno, "Batch file %s open error",
1569 full_fname(batch_name));
1570 exit_cleanup(RERR_FILEIO);
1573 read_stream_flags(batch_fd);
1575 write_stream_flags(batch_fd);
1577 if (write_batch < 0)
1584 } else if (am_daemon)
1585 return daemon_main();
1587 if (am_server && protect_args) {
1588 char buf[MAXPATHLEN];
1590 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1591 if (!parse_arguments(&argc, (const char ***) &argv)) {
1593 exit_cleanup(RERR_SYNTAX);
1599 exit_cleanup(RERR_SYNTAX);
1603 set_nonblocking(STDIN_FILENO);
1604 set_nonblocking(STDOUT_FILENO);
1606 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1607 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1610 ret = start_client(argc, argv);
1612 exit_cleanup(RERR_STARTCLIENT);