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 shutting_down;
77 extern struct stats stats;
78 extern char *stdout_format;
79 extern char *logfile_format;
80 extern char *filesfrom_host;
81 extern char *partial_dir;
82 extern char *dest_option;
83 extern char *rsync_path;
84 extern char *shell_cmd;
85 extern char *batch_name;
86 extern char *password_file;
87 extern char *backup_dir;
88 extern char curr_dir[MAXPATHLEN];
89 extern char backup_dir_buf[MAXPATHLEN];
90 extern char *basis_dir[MAX_BASIS_DIRS+1];
91 extern struct file_list *first_flist;
92 extern filter_rule_list daemon_filter_list;
98 int daemon_over_rsh = 0;
99 mode_t orig_umask = 0;
100 int batch_gen_fd = -1;
101 int sender_keeps_checksum = 0;
103 /* There's probably never more than at most 2 outstanding child processes,
104 * but set it higher, just in case. */
105 #define MAXCHILDPROCS 7
107 #ifdef HAVE_SIGACTION
108 # ifdef HAVE_SIGPROCMASK
109 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
111 # define SIGACTMASK(n,h) SIGACTION(n,h)
113 static struct sigaction sigact;
119 } pid_stat_table[MAXCHILDPROCS];
121 static time_t starttime, endtime;
122 static int64 total_read, total_written;
124 static void show_malloc_stats(void);
126 /* Works like waitpid(), but if we already harvested the child pid in our
127 * remember_children(), we succeed instead of returning an error. */
128 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
133 waited_pid = waitpid(pid, status_ptr, flags);
134 } while (waited_pid == -1 && errno == EINTR);
136 if (waited_pid == -1 && errno == ECHILD) {
137 /* Status of requested child no longer available: check to
138 * see if it was processed by remember_children(). */
140 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
141 if (pid == pid_stat_table[cnt].pid) {
142 *status_ptr = pid_stat_table[cnt].status;
143 pid_stat_table[cnt].pid = 0;
152 /* Wait for a process to exit, calling io_flush while waiting. */
153 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
158 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
160 io_flush(FULL_FLUSH);
163 /* TODO: If the child exited on a signal, then log an
164 * appropriate error message. Perhaps we should also accept a
165 * message describing the purpose of the child. Also indicate
166 * this to the caller so that they know something went wrong. */
167 if (waited_pid < 0) {
168 rsyserr(FERROR, errno, "waitpid");
169 *exit_code_ptr = RERR_WAITCHILD;
170 } else if (!WIFEXITED(status)) {
172 if (WCOREDUMP(status))
173 *exit_code_ptr = RERR_CRASHED;
176 if (WIFSIGNALED(status))
177 *exit_code_ptr = RERR_TERMINATED;
179 *exit_code_ptr = RERR_WAITCHILD;
181 *exit_code_ptr = WEXITSTATUS(status);
184 void write_del_stats(int f)
187 write_int(f, NDX_DEL_STATS);
189 write_ndx(f, NDX_DEL_STATS);
190 write_varint(f, stats.deleted_files - stats.deleted_dirs
191 - stats.deleted_symlinks - stats.deleted_devices
192 - stats.deleted_specials);
193 write_varint(f, stats.deleted_dirs);
194 write_varint(f, stats.deleted_symlinks);
195 write_varint(f, stats.deleted_devices);
196 write_varint(f, stats.deleted_specials);
199 void read_del_stats(int f)
201 stats.deleted_files = read_varint(f);
202 stats.deleted_files += stats.deleted_dirs = read_varint(f);
203 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
204 stats.deleted_files += stats.deleted_devices = read_varint(f);
205 stats.deleted_files += stats.deleted_specials = read_varint(f);
208 /* This function gets called from all 3 processes. We want the client side
209 * to actually output the text, but the sender is the only process that has
210 * all the stats we need. So, if we're a client sender, we do the report.
211 * If we're a server sender, we write the stats on the supplied fd. If
212 * we're the client receiver we read the stats from the supplied fd and do
213 * the report. All processes might also generate a set of debug stats, if
214 * the verbose level is high enough (this is the only thing that the
215 * generator process and the server receiver ever do here). */
216 static void handle_stats(int f)
218 endtime = time(NULL);
220 /* Cache two stats because the read/write code can change it. */
221 total_read = stats.total_read;
222 total_written = stats.total_written;
224 if (INFO_GTE(STATS, 3)) {
225 /* These come out from every process */
234 if (f == -1 || !am_sender)
240 write_varlong30(f, total_read, 3);
241 write_varlong30(f, total_written, 3);
242 write_varlong30(f, stats.total_size, 3);
243 if (protocol_version >= 29) {
244 write_varlong30(f, stats.flist_buildtime, 3);
245 write_varlong30(f, stats.flist_xfertime, 3);
251 /* this is the client */
253 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
255 else if (!am_sender) {
256 /* Read the first two in opposite order because the meaning of
257 * read/write swaps when switching from sender to receiver. */
258 total_written = read_varlong30(f, 3);
259 total_read = read_varlong30(f, 3);
260 stats.total_size = read_varlong30(f, 3);
261 if (protocol_version >= 29) {
262 stats.flist_buildtime = read_varlong30(f, 3);
263 stats.flist_xfertime = read_varlong30(f, 3);
265 } else if (write_batch) {
266 /* The --read-batch process is going to be a client
267 * receiver, so we need to give it the stats. */
268 write_varlong30(batch_fd, total_read, 3);
269 write_varlong30(batch_fd, total_written, 3);
270 write_varlong30(batch_fd, stats.total_size, 3);
271 if (protocol_version >= 29) {
272 write_varlong30(batch_fd, stats.flist_buildtime, 3);
273 write_varlong30(batch_fd, stats.flist_xfertime, 3);
278 static void output_itemized_counts(const char *prefix, int *counts)
280 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
281 char buf[1024], *pre = " (";
283 int total = counts[0];
285 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
286 for (j = 0; j < 5; j++) {
288 len += snprintf(buf+len, sizeof buf - len - 2,
290 pre, labels[j], comma_num(counts[j]));
297 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
300 static void output_summary(void)
302 if (INFO_GTE(STATS, 2)) {
303 rprintf(FCLIENT, "\n");
304 output_itemized_counts("Number of files", &stats.num_files);
305 if (protocol_version >= 29)
306 output_itemized_counts("Number of created files", &stats.created_files);
307 if (protocol_version >= 31)
308 output_itemized_counts("Number of deleted files", &stats.deleted_files);
309 rprintf(FINFO,"Number of regular files transferred: %s\n",
310 comma_num(stats.xferred_files));
311 rprintf(FINFO,"Total file size: %s bytes\n",
312 human_num(stats.total_size));
313 rprintf(FINFO,"Total transferred file size: %s bytes\n",
314 human_num(stats.total_transferred_size));
315 rprintf(FINFO,"Literal data: %s bytes\n",
316 human_num(stats.literal_data));
317 rprintf(FINFO,"Matched data: %s bytes\n",
318 human_num(stats.matched_data));
319 rprintf(FINFO,"File list size: %s\n",
320 human_num(stats.flist_size));
321 if (stats.flist_buildtime) {
323 "File list generation time: %s seconds\n",
324 comma_dnum((double)stats.flist_buildtime / 1000, 3));
326 "File list transfer time: %s seconds\n",
327 comma_dnum((double)stats.flist_xfertime / 1000, 3));
329 rprintf(FINFO,"Total bytes sent: %s\n",
330 human_num(total_written));
331 rprintf(FINFO,"Total bytes received: %s\n",
332 human_num(total_read));
335 if (INFO_GTE(STATS, 1)) {
336 rprintf(FCLIENT, "\n");
338 "sent %s bytes received %s bytes %s bytes/sec\n",
339 human_num(total_written), human_num(total_read),
340 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
341 rprintf(FINFO, "total size is %s speedup is %s%s\n",
342 human_num(stats.total_size),
343 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
344 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
353 * If our C library can get malloc statistics, then show them to FINFO
355 static void show_malloc_stats(void)
362 rprintf(FCLIENT, "\n");
363 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
364 getpid(), am_server ? "server " : "",
365 am_daemon ? "daemon " : "", who_am_i());
366 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
368 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
370 rprintf(FINFO, " smblks: %10ld\n",
372 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
374 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
376 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
377 (long)mi.arena + mi.hblkhd);
378 rprintf(FINFO, " usmblks: %10ld\n",
380 rprintf(FINFO, " fsmblks: %10ld\n",
382 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
384 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
386 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
388 #endif /* HAVE_MALLINFO */
392 /* Start the remote shell. cmd may be NULL to use the default. */
393 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
394 int *f_in_p, int *f_out_p)
397 char *args[MAX_ARGS];
401 if (!read_batch && !local_server) {
402 char *t, *f, in_quote = '\0';
403 char *rsh_env = getenv(RSYNC_RSH_ENV);
408 cmd = strdup(cmd); /*MEMORY LEAK*/
412 for (t = f = cmd; *f; f++) {
415 /* Comparison leaves rooms for server_options(). */
416 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
419 while (*f != ' ' || in_quote) {
423 "Missing trailing-%c in remote-shell command.\n",
425 exit_cleanup(RERR_SYNTAX);
430 if (*f == '\'' || *f == '"') {
435 if (*f == in_quote && *++f != in_quote) {
445 /* check to see if we've already been given '-l user' in
446 * the remote-shell command */
447 for (i = 0; i < argc-1; i++) {
448 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
453 /* remsh (on HPUX) takes the arguments the other way around */
454 args[argc++] = machine;
455 if (user && !(daemon_over_rsh && dash_l_set)) {
460 if (user && !(daemon_over_rsh && dash_l_set)) {
464 args[argc++] = machine;
467 args[argc++] = rsync_path;
469 if (blocking_io < 0) {
471 if ((cp = strrchr(cmd, '/')) != NULL)
475 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
479 server_options(args,&argc);
481 if (argc >= MAX_ARGS - 2)
487 if (!daemon_over_rsh) {
488 while (remote_argc > 0) {
489 if (argc >= MAX_ARGS - 1) {
491 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
492 exit_cleanup(RERR_SYNTAX);
494 args[argc++] = *remote_argv++;
501 if (DEBUG_GTE(CMD, 2)) {
502 for (i = 0; i < argc; i++)
503 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
504 rprintf(FCLIENT, "\n");
508 int from_gen_pipe[2];
509 set_allow_inc_recurse();
510 if (fd_pair(from_gen_pipe) < 0) {
511 rsyserr(FERROR, errno, "pipe");
512 exit_cleanup(RERR_IPC);
514 batch_gen_fd = from_gen_pipe[0];
515 *f_out_p = from_gen_pipe[1];
517 pid = (pid_t)-1; /* no child pid */
521 } else if (local_server) {
522 /* If the user didn't request --[no-]whole-file, force
523 * it on, but only if we're not batch processing. */
524 if (whole_file < 0 && !write_batch)
526 set_allow_inc_recurse();
527 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
532 pid = piped_child(args, f_in_p, f_out_p);
536 if (protect_args && !daemon_over_rsh)
537 send_protected_args(*f_out_p, args);
543 out_of_memory("do_cmd");
544 return 0; /* not reached */
547 /* The receiving side operates in one of two modes:
549 * 1. it receives any number of files into a destination directory,
550 * placing them according to their names in the file-list.
552 * 2. it receives a single file and saves it using the name in the
553 * destination path instead of its file-list name. This requires a
554 * "local name" for writing out the destination file.
556 * So, our task is to figure out what mode/local-name we need.
557 * For mode 1, we change into the destination directory and return NULL.
558 * For mode 2, we change into the directory containing the destination
559 * file (if we aren't already there) and return the local-name. */
560 static char *get_local_name(struct file_list *flist, char *dest_path)
566 if (DEBUG_GTE(RECV, 1)) {
567 rprintf(FINFO, "get_local_name count=%d %s\n",
568 file_total, NS(dest_path));
571 if (!dest_path || list_only)
574 if (daemon_filter_list.head) {
575 char *slash = strrchr(dest_path, '/');
576 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
580 if ((*dest_path != '.' || dest_path[1] != '\0')
581 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
582 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
583 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
585 exit_cleanup(RERR_FILESELECT);
591 /* See what currently exists at the destination. */
592 if ((statret = do_stat(dest_path, &st)) == 0) {
593 /* If the destination is a dir, enter it and use mode 1. */
594 if (S_ISDIR(st.st_mode)) {
595 if (!change_dir(dest_path, CD_NORMAL)) {
596 rsyserr(FERROR, errno, "change_dir#1 %s failed",
597 full_fname(dest_path));
598 exit_cleanup(RERR_FILESELECT);
602 if (file_total > 1) {
604 "ERROR: destination must be a directory when"
605 " copying more than 1 file\n");
606 exit_cleanup(RERR_FILESELECT);
608 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
610 "ERROR: cannot overwrite non-directory"
611 " with a directory\n");
612 exit_cleanup(RERR_FILESELECT);
614 } else if (errno != ENOENT) {
615 /* If we don't know what's at the destination, fail. */
616 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
617 full_fname(dest_path));
618 exit_cleanup(RERR_FILESELECT);
621 cp = strrchr(dest_path, '/');
623 /* If we need a destination directory because the transfer is not
624 * of a single non-directory or the user has requested one via a
625 * destination path ending in a slash, create one and use mode 1. */
626 if (file_total > 1 || (cp && !cp[1])) {
627 /* Lop off the final slash (if any). */
633 "ERROR: destination path is not a directory\n");
634 exit_cleanup(RERR_SYNTAX);
637 if (mkdir_defmode(dest_path) != 0) {
638 rsyserr(FERROR, errno, "mkdir %s failed",
639 full_fname(dest_path));
640 exit_cleanup(RERR_FILEIO);
643 if (flist->high >= flist->low
644 && strcmp(flist->files[flist->low]->basename, ".") == 0)
645 flist->files[0]->flags |= FLAG_DIR_CREATED;
647 if (INFO_GTE(NAME, 1))
648 rprintf(FINFO, "created directory %s\n", dest_path);
651 /* Indicate that dest dir doesn't really exist. */
655 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
656 rsyserr(FERROR, errno, "change_dir#2 %s failed",
657 full_fname(dest_path));
658 exit_cleanup(RERR_FILESELECT);
664 /* Otherwise, we are writing a single file, possibly on top of an
665 * existing non-directory. Change to the item's parent directory
666 * (if it has a path component), return the basename of the
667 * destination file as the local name, and use mode 2. */
675 if (!change_dir(dest_path, CD_NORMAL)) {
676 rsyserr(FERROR, errno, "change_dir#3 %s failed",
677 full_fname(dest_path));
678 exit_cleanup(RERR_FILESELECT);
685 /* This function checks on our alternate-basis directories. If we're in
686 * dry-run mode and the destination dir does not yet exist, we'll try to
687 * tweak any dest-relative paths to make them work for a dry-run (the
688 * destination dir must be in curr_dir[] when this function is called).
689 * We also warn about any arg that is non-existent or not a directory. */
690 static void check_alt_basis_dirs(void)
693 char **dir_p, *slash = strrchr(curr_dir, '/');
695 for (dir_p = basis_dir; *dir_p; dir_p++) {
696 if (dry_run > 1 && **dir_p != '/') {
697 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
698 char *new = new_array(char, len);
700 out_of_memory("check_alt_basis_dirs");
701 if (slash && strncmp(*dir_p, "../", 3) == 0) {
702 /* We want to remove only one leading "../" prefix for
703 * the directory we couldn't create in dry-run mode:
704 * this ensures that any other ".." references get
705 * evaluated the same as they would for a live copy. */
707 pathjoin(new, len, curr_dir, *dir_p + 3);
710 pathjoin(new, len, curr_dir, *dir_p);
713 if (do_stat(*dir_p, &st) < 0) {
714 rprintf(FWARNING, "%s arg does not exist: %s\n",
715 dest_option, *dir_p);
716 } else if (!S_ISDIR(st.st_mode)) {
717 rprintf(FWARNING, "%s arg is not a dir: %s\n",
718 dest_option, *dir_p);
723 /* This is only called by the sender. */
724 static void read_final_goodbye(int f_in, int f_out)
728 char xname[MAXPATHLEN];
730 shutting_down = True;
732 if (protocol_version < 29)
735 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
736 if (protocol_version >= 31 && i == NDX_DONE) {
738 write_ndx(f_out, NDX_DONE);
740 if (batch_gen_fd >= 0) {
741 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
742 read_del_stats(batch_gen_fd);
744 write_int(f_out, NDX_DONE);
746 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
751 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
753 exit_cleanup(RERR_PROTOCOL);
757 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
759 struct file_list *flist;
762 if (DEBUG_GTE(SEND, 1)) {
763 rprintf(FINFO, "server_sender starting pid=%ld\n",
767 if (am_daemon && lp_write_only(module_id)) {
768 rprintf(FERROR, "ERROR: module is write only\n");
769 exit_cleanup(RERR_SYNTAX);
772 if (am_daemon && read_only && remove_source_files) {
774 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
775 remove_source_files == 1 ? "source" : "sent");
776 exit_cleanup(RERR_SYNTAX);
780 if (!relative_paths) {
781 if (!change_dir(dir, CD_NORMAL)) {
782 rsyserr(FERROR, errno, "change_dir#3 %s failed",
784 exit_cleanup(RERR_FILESELECT);
790 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
796 flist = send_file_list(f_out,argc,argv);
797 if (!flist || flist->used == 0)
800 io_start_buffering_in(f_in);
802 send_files(f_in, f_out);
803 io_flush(FULL_FLUSH);
805 if (protocol_version >= 24)
806 read_final_goodbye(f_in, f_out);
807 io_flush(FULL_FLUSH);
812 static int do_recv(int f_in, int f_out, char *local_name)
818 /* The receiving side mustn't obey this, or an existing symlink that
819 * points to an identical file won't be replaced by the referent. */
820 copy_links = copy_dirlinks = copy_unsafe_links = 0;
822 #ifdef SUPPORT_HARD_LINKS
823 if (preserve_hard_links && !inc_recurse)
824 match_hard_links(first_flist);
827 if (fd_pair(error_pipe) < 0) {
828 rsyserr(FERROR, errno, "pipe failed in do_recv");
829 exit_cleanup(RERR_IPC);
833 int ret = make_path(backup_dir_buf, MKP_DROP_NAME); /* drops trailing slash */
835 exit_cleanup(RERR_SYNTAX);
837 rprintf(FINFO, "Created backup_dir %s\n", backup_dir_buf);
838 else if (INFO_GTE(BACKUP, 1))
839 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
842 io_flush(FULL_FLUSH);
844 if ((pid = do_fork()) == -1) {
845 rsyserr(FERROR, errno, "fork failed in do_recv");
846 exit_cleanup(RERR_IPC);
850 send_msgs_to_gen = am_server;
852 close(error_pipe[0]);
854 /* We can't let two processes write to the socket at one time. */
855 io_end_multiplex_out(MPLX_SWITCHING);
859 f_out = error_pipe[1];
861 bwlimit_writemax = 0; /* receiver doesn't need to do this */
864 io_start_buffering_in(f_in);
865 io_start_multiplex_out(f_out);
867 recv_files(f_in, f_out, local_name);
868 io_flush(FULL_FLUSH);
871 if (output_needs_newline) {
873 output_needs_newline = 0;
876 write_int(f_out, NDX_DONE);
877 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
878 io_flush(FULL_FLUSH);
880 /* Handle any keep-alive packets from the post-processing work
881 * that the generator does. */
882 if (protocol_version >= 29) {
883 kluge_around_eof = -1;
885 /* This should only get stopped via a USR2 signal. */
886 read_final_goodbye(f_in, f_out);
888 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
890 exit_cleanup(RERR_PROTOCOL);
893 /* Finally, we go to sleep until our parent kills us with a
894 * USR2 signal. We sleep for a short time, as on some OSes
895 * a signal won't interrupt a sleep! */
902 io_end_multiplex_in(MPLX_SWITCHING);
903 if (write_batch && !am_server)
906 close(error_pipe[1]);
910 f_in = error_pipe[0];
912 io_start_buffering_out(f_out);
913 io_start_multiplex_in(f_in);
915 #ifdef SUPPORT_HARD_LINKS
916 if (preserve_hard_links && inc_recurse) {
917 struct file_list *flist;
918 for (flist = first_flist; flist; flist = flist->next)
919 match_hard_links(flist);
923 generate_files(f_out, local_name);
926 io_flush(FULL_FLUSH);
927 shutting_down = True;
928 if (protocol_version >= 24) {
929 /* send a final goodbye message */
930 write_ndx(f_out, NDX_DONE);
932 io_flush(FULL_FLUSH);
935 wait_process_with_flush(pid, &exit_code);
939 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
942 struct file_list *flist;
943 char *local_name = NULL;
946 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
947 /* We can't mix messages with files-from data on the socket,
948 * so temporarily turn off info/debug messages. */
949 negate_output_levels();
954 if (DEBUG_GTE(RECV, 1)) {
955 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
956 argc, (long)getpid());
959 if (am_daemon && read_only) {
960 rprintf(FERROR,"ERROR: module is read only\n");
961 exit_cleanup(RERR_SYNTAX);
969 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
970 rsyserr(FERROR, errno, "change_dir#4 %s failed",
972 exit_cleanup(RERR_FILESELECT);
976 if (protocol_version >= 30)
977 io_start_multiplex_in(f_in);
979 io_start_buffering_in(f_in);
980 recv_filter_list(f_in);
982 if (filesfrom_fd >= 0) {
983 /* We need to send the files-from names to the sender at the
984 * same time that we receive the file-list from them, so we
985 * need the IO routines to automatically write out the names
986 * onto our f_out socket as we read the file-list. This
987 * avoids both deadlock and extra delays/buffers. */
988 start_filesfrom_forwarding(filesfrom_fd);
992 flist = recv_file_list(f_in);
994 rprintf(FERROR,"server_recv: recv_file_list error\n");
995 exit_cleanup(RERR_FILESELECT);
997 if (inc_recurse && file_total == 1)
998 recv_additional_file_list(f_in);
1001 negate_output_levels();
1004 local_name = get_local_name(flist,argv[0]);
1006 /* Now that we know what our destination directory turned out to be,
1007 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1008 if (sanitize_paths) {
1010 for (dir_p = basis_dir; *dir_p; dir_p++)
1011 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1013 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1015 check_alt_basis_dirs();
1017 if (daemon_filter_list.head) {
1019 filter_rule_list *elp = &daemon_filter_list;
1021 for (dir_p = basis_dir; *dir_p; dir_p++) {
1024 dir += module_dirlen;
1025 if (check_filter(elp, FLOG, dir, 1) < 0)
1026 goto options_rejected;
1028 if (partial_dir && *partial_dir == '/'
1029 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1032 "Your options have been rejected by the server.\n");
1033 exit_cleanup(RERR_SYNTAX);
1037 exit_code = do_recv(f_in, f_out, local_name);
1038 exit_cleanup(exit_code);
1042 int child_main(int argc, char *argv[])
1044 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1049 void start_server(int f_in, int f_out, int argc, char *argv[])
1051 set_nonblocking(f_in);
1052 set_nonblocking(f_out);
1054 io_set_sock_fds(f_in, f_out);
1055 setup_protocol(f_out, f_in);
1057 if (protocol_version >= 23)
1058 io_start_multiplex_out(f_out);
1059 if (am_daemon && io_timeout && protocol_version >= 31)
1060 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1063 keep_dirlinks = 0; /* Must be disabled on the sender. */
1064 if (need_messages_from_generator)
1065 io_start_multiplex_in(f_in);
1067 io_start_buffering_in(f_in);
1068 recv_filter_list(f_in);
1069 do_server_sender(f_in, f_out, argc, argv);
1071 do_server_recv(f_in, f_out, argc, argv);
1075 /* This is called once the connection has been negotiated. It is used
1076 * for rsyncd, remote-shell, and local connections. */
1077 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1079 struct file_list *flist = NULL;
1080 int exit_code = 0, exit_code2 = 0;
1081 char *local_name = NULL;
1083 cleanup_child_pid = pid;
1085 set_nonblocking(f_in);
1086 set_nonblocking(f_out);
1089 io_set_sock_fds(f_in, f_out);
1090 setup_protocol(f_out,f_in);
1092 /* We set our stderr file handle to blocking because ssh might have
1093 * set it to non-blocking. This can be particularly troublesome if
1094 * stderr is a clone of stdout, because ssh would have set our stdout
1095 * to non-blocking at the same time (which can easily cause us to lose
1096 * output from our print statements). This kluge shouldn't cause ssh
1097 * any problems for how we use it. Note also that we delayed setting
1098 * this until after the above protocol setup so that we know for sure
1099 * that ssh is done twiddling its file descriptors. */
1100 set_blocking(STDERR_FILENO);
1103 keep_dirlinks = 0; /* Must be disabled on the sender. */
1106 && (log_format_has(stdout_format, 'C')
1107 || log_format_has(logfile_format, 'C')))
1108 sender_keeps_checksum = 1;
1110 if (protocol_version >= 30)
1111 io_start_multiplex_out(f_out);
1113 io_start_buffering_out(f_out);
1114 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1115 io_start_multiplex_in(f_in);
1117 io_start_buffering_in(f_in);
1118 send_filter_list(f_out);
1120 filesfrom_fd = f_in;
1122 if (write_batch && !am_server)
1123 start_write_batch(f_out);
1124 flist = send_file_list(f_out, argc, argv);
1125 if (DEBUG_GTE(FLIST, 3))
1126 rprintf(FINFO,"file list sent\n");
1128 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1129 io_start_multiplex_in(f_in);
1131 io_flush(NORMAL_FLUSH);
1132 send_files(f_in, f_out);
1133 io_flush(FULL_FLUSH);
1135 if (protocol_version >= 24)
1136 read_final_goodbye(f_in, f_out);
1138 if (DEBUG_GTE(EXIT, 2))
1139 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1140 io_flush(FULL_FLUSH);
1141 wait_process_with_flush(pid, &exit_code);
1144 io_flush(FULL_FLUSH);
1145 exit_cleanup(exit_code);
1149 if (protocol_version >= 23)
1150 io_start_multiplex_in(f_in);
1151 if (need_messages_from_generator)
1152 io_start_multiplex_out(f_out);
1154 io_start_buffering_out(f_out);
1157 send_filter_list(read_batch ? -1 : f_out);
1159 if (filesfrom_fd >= 0) {
1160 start_filesfrom_forwarding(filesfrom_fd);
1164 if (write_batch && !am_server)
1165 start_write_batch(f_in);
1166 flist = recv_file_list(f_in);
1167 if (inc_recurse && file_total == 1)
1168 recv_additional_file_list(f_in);
1170 if (flist && flist->used > 0) {
1171 local_name = get_local_name(flist, argv[0]);
1173 check_alt_basis_dirs();
1175 exit_code2 = do_recv(f_in, f_out, local_name);
1182 if (DEBUG_GTE(RECV, 1))
1183 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1184 io_flush(FULL_FLUSH);
1185 wait_process_with_flush(pid, &exit_code);
1188 return MAX(exit_code, exit_code2);
1191 static int copy_argv(char *argv[])
1195 for (i = 0; argv[i]; i++) {
1196 if (!(argv[i] = strdup(argv[i]))) {
1197 rprintf (FERROR, "out of memory at %s(%d)\n",
1198 __FILE__, __LINE__);
1207 /* Start a client for either type of remote connection. Work out
1208 * whether the arguments request a remote shell or rsyncd connection,
1209 * and call the appropriate connection function, then run_client.
1211 * Calls either start_socket_client (for sockets) or do_cmd and
1212 * client_run (for ssh). */
1213 static int start_client(int argc, char *argv[])
1215 char *p, *shell_machine = NULL, *shell_user = NULL;
1222 /* Don't clobber argv[] so that ps(1) can still show the right
1224 if ((ret = copy_argv(argv)) != 0)
1227 if (!read_batch) { /* for read_batch, NO source is specified */
1228 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1229 if (path) { /* source is remote */
1236 if (argc == 1 || **argv == ':')
1237 argc = 0; /* no dest arg */
1238 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1240 "The source and destination cannot both be remote.\n");
1241 exit_cleanup(RERR_SYNTAX);
1243 remote_argc--; /* don't count dest */
1246 if (filesfrom_host && *filesfrom_host
1247 && strcmp(filesfrom_host, shell_machine) != 0) {
1249 "--files-from hostname is not the same as the transfer hostname\n");
1250 exit_cleanup(RERR_SYNTAX);
1254 daemon_over_rsh = shell_cmd ? 1 : -1;
1255 } else { /* source is local, check dest arg */
1260 remote_argv = argv + argc;
1262 static char *dotarg[1] = { "." };
1264 remote_argv = dotarg;
1268 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1269 if (path && filesfrom_host && *filesfrom_host
1270 && strcmp(filesfrom_host, shell_machine) != 0) {
1272 "--files-from hostname is not the same as the transfer hostname\n");
1273 exit_cleanup(RERR_SYNTAX);
1275 if (!path) { /* no hostspec found, so src & dest are local */
1277 if (filesfrom_host) {
1279 "--files-from cannot be remote when the transfer is local\n");
1280 exit_cleanup(RERR_SYNTAX);
1282 shell_machine = NULL;
1283 } else { /* hostspec was found, so dest is remote */
1286 daemon_over_rsh = shell_cmd ? 1 : -1;
1289 } else { /* read_batch */
1291 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1292 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1293 exit_cleanup(RERR_SYNTAX);
1295 remote_argv = argv += argc - 1;
1296 remote_argc = argc = 1;
1301 int dummy_port = rsync_port;
1303 /* For local source, extra source args must not have hostspec. */
1304 for (i = 1; i < argc; i++) {
1305 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1306 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1307 exit_cleanup(RERR_SYNTAX);
1312 int dummy_port = rsync_port;
1314 /* For remote source, any extra source args must have either
1315 * the same hostname or an empty hostname. */
1316 for (i = 1; i < remote_argc; i++) {
1317 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1319 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1320 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1321 exit_cleanup(RERR_SYNTAX);
1323 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1324 rprintf(FERROR, "All source args must come from the same machine.\n");
1325 exit_cleanup(RERR_SYNTAX);
1327 if (rsync_port != dummy_port) {
1328 if (!rsync_port || !dummy_port)
1329 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1331 rprintf(FERROR, "All source args must use the same port number.\n");
1332 exit_cleanup(RERR_SYNTAX);
1334 remote_argv[i] = arg;
1338 if (daemon_over_rsh < 0)
1339 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1341 if (password_file && !daemon_over_rsh) {
1342 rprintf(FERROR, "The --password-file option may only be "
1343 "used when accessing an rsync daemon.\n");
1344 exit_cleanup(RERR_SYNTAX);
1347 if (connect_timeout) {
1348 rprintf(FERROR, "The --contimeout option may only be "
1349 "used when connecting to an rsync daemon.\n");
1350 exit_cleanup(RERR_SYNTAX);
1353 if (shell_machine) {
1354 p = strrchr(shell_machine,'@');
1357 shell_user = shell_machine;
1358 shell_machine = p+1;
1362 if (DEBUG_GTE(CMD, 2)) {
1363 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1364 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1365 remote_argv ? NS(remote_argv[0]) : "");
1368 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1371 /* if we're running an rsync server on the remote host over a
1372 * remote shell command, we need to do the RSYNCD protocol first */
1373 if (daemon_over_rsh) {
1375 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1380 ret = client_run(f_in, f_out, pid, argc, argv);
1389 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1391 exit_cleanup(RERR_SIGNAL1);
1394 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1400 _exit(RERR_PARTIAL);
1404 RETSIGTYPE remember_children(UNUSED(int val))
1409 /* An empty waitpid() loop was put here by Tridge and we could never
1410 * get him to explain why he put it in, so rather than taking it
1411 * out we're instead saving the child exit statuses for later use.
1412 * The waitpid() loop presumably eliminates all possibility of leaving
1413 * zombie children, maybe that's why he did it. */
1414 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1415 /* save the child's exit status */
1416 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1417 if (pid_stat_table[cnt].pid == 0) {
1418 pid_stat_table[cnt].pid = pid;
1419 pid_stat_table[cnt].status = status;
1425 #ifndef HAVE_SIGACTION
1426 signal(SIGCHLD, remember_children);
1432 * This routine catches signals and tries to send them to gdb.
1434 * Because it's called from inside a signal handler it ought not to
1435 * use too many library routines.
1437 * @todo Perhaps use "screen -X" instead/as well, to help people
1438 * debugging without easy access to X. Perhaps use an environment
1439 * variable, or just call a script?
1441 * @todo The /proc/ magic probably only works on Linux (and
1442 * Solaris?) Can we be more portable?
1444 #ifdef MAINTAINER_MODE
1445 const char *get_panic_action(void)
1447 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1452 return "xterm -display :0 -T Panic -n Panic "
1453 "-e gdb /proc/%d/exe %d";
1458 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1460 * This signal handler is only installed if we were configured with
1461 * --enable-maintainer-mode. Perhaps it should always be on and we
1462 * should just look at the environment variable, but I'm a bit leery
1463 * of a signal sending us into a busy loop.
1465 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1470 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1471 getpid(), getpid());
1473 /* Unless we failed to execute gdb, we allow the process to
1474 * continue. I'm not sure if that's right. */
1475 ret = system(cmd_buf);
1482 int main(int argc,char *argv[])
1485 int orig_argc = argc;
1486 char **orig_argv = argv;
1487 #ifdef HAVE_SIGACTION
1488 # ifdef HAVE_SIGPROCMASK
1491 sigemptyset(&sigmask);
1493 sigact.sa_flags = SA_NOCLDSTOP;
1495 SIGACTMASK(SIGUSR1, sigusr1_handler);
1496 SIGACTMASK(SIGUSR2, sigusr2_handler);
1497 SIGACTMASK(SIGCHLD, remember_children);
1498 #ifdef MAINTAINER_MODE
1499 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1500 SIGACTMASK(SIGFPE, rsync_panic_handler);
1501 SIGACTMASK(SIGABRT, rsync_panic_handler);
1502 SIGACTMASK(SIGBUS, rsync_panic_handler);
1505 starttime = time(NULL);
1508 am_root = our_uid == 0;
1510 memset(&stats, 0, sizeof(stats));
1514 exit_cleanup(RERR_SYNTAX);
1517 /* we set a 0 umask so that correct file permissions can be
1519 orig_umask = umask(0);
1521 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1522 setlocale(LC_CTYPE, "");
1525 if (!parse_arguments(&argc, (const char ***) &argv)) {
1526 /* FIXME: We ought to call the same error-handling
1527 * code here, rather than relying on getopt. */
1529 exit_cleanup(RERR_SYNTAX);
1532 SIGACTMASK(SIGINT, sig_int);
1533 SIGACTMASK(SIGHUP, sig_int);
1534 SIGACTMASK(SIGTERM, sig_int);
1535 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1536 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1539 /* Ignore SIGPIPE; we consistently check error codes and will
1541 SIGACTION(SIGPIPE, SIG_IGN);
1543 SIGACTION(SIGXFSZ, SIG_IGN);
1546 /* Initialize change_dir() here because on some old systems getcwd
1547 * (implemented by forking "pwd" and reading its output) doesn't
1548 * work when there are other child processes. Also, on all systems
1549 * that implement getcwd that way "pwd" can't be found after chroot. */
1550 change_dir(NULL, CD_NORMAL);
1554 if ((write_batch || read_batch) && !am_server) {
1556 write_batch_shell_file(orig_argc, orig_argv, argc);
1558 if (read_batch && strcmp(batch_name, "-") == 0)
1559 batch_fd = STDIN_FILENO;
1561 batch_fd = do_open(batch_name,
1562 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1563 : O_RDONLY, S_IRUSR | S_IWUSR);
1566 rsyserr(FERROR, errno, "Batch file %s open error",
1567 full_fname(batch_name));
1568 exit_cleanup(RERR_FILEIO);
1571 read_stream_flags(batch_fd);
1573 write_stream_flags(batch_fd);
1575 if (write_batch < 0)
1582 } else if (am_daemon)
1583 return daemon_main();
1585 if (am_server && protect_args) {
1586 char buf[MAXPATHLEN];
1588 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1589 if (!parse_arguments(&argc, (const char ***) &argv)) {
1591 exit_cleanup(RERR_SYNTAX);
1597 exit_cleanup(RERR_SYNTAX);
1601 set_nonblocking(STDIN_FILENO);
1602 set_nonblocking(STDOUT_FILENO);
1604 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1605 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1608 ret = start_client(argc, argv);
1610 exit_cleanup(RERR_STARTCLIENT);