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-2015 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 dev_t filesystem_dev;
74 extern pid_t cleanup_child_pid;
75 extern size_t bwlimit_writemax;
76 extern unsigned int module_dirlen;
77 extern BOOL flist_receiving_enabled;
78 extern BOOL shutting_down;
79 extern int backup_dir_len;
80 extern int basis_dir_cnt;
81 extern struct stats stats;
82 extern char *stdout_format;
83 extern char *logfile_format;
84 extern char *filesfrom_host;
85 extern char *partial_dir;
86 extern char *dest_option;
87 extern char *rsync_path;
88 extern char *shell_cmd;
89 extern char *batch_name;
90 extern char *password_file;
91 extern char *backup_dir;
92 extern char curr_dir[MAXPATHLEN];
93 extern char backup_dir_buf[MAXPATHLEN];
94 extern char *basis_dir[MAX_BASIS_DIRS+1];
95 extern struct file_list *first_flist;
96 extern filter_rule_list daemon_filter_list;
100 int am_receiver = 0; /* Only set to 1 after the receiver/generator fork. */
101 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
102 int local_server = 0;
103 int daemon_over_rsh = 0;
104 mode_t orig_umask = 0;
105 int batch_gen_fd = -1;
106 int sender_keeps_checksum = 0;
108 /* There's probably never more than at most 2 outstanding child processes,
109 * but set it higher, just in case. */
110 #define MAXCHILDPROCS 7
112 #ifdef HAVE_SIGACTION
113 # ifdef HAVE_SIGPROCMASK
114 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
116 # define SIGACTMASK(n,h) SIGACTION(n,h)
118 static struct sigaction sigact;
124 } pid_stat_table[MAXCHILDPROCS];
126 static time_t starttime, endtime;
127 static int64 total_read, total_written;
129 static void show_malloc_stats(void);
131 /* Works like waitpid(), but if we already harvested the child pid in our
132 * remember_children(), we succeed instead of returning an error. */
133 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
138 waited_pid = waitpid(pid, status_ptr, flags);
139 } while (waited_pid == -1 && errno == EINTR);
141 if (waited_pid == -1 && errno == ECHILD) {
142 /* Status of requested child no longer available: check to
143 * see if it was processed by remember_children(). */
145 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
146 if (pid == pid_stat_table[cnt].pid) {
147 *status_ptr = pid_stat_table[cnt].status;
148 pid_stat_table[cnt].pid = 0;
157 /* Wait for a process to exit, calling io_flush while waiting. */
158 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
163 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
165 io_flush(FULL_FLUSH);
168 /* TODO: If the child exited on a signal, then log an
169 * appropriate error message. Perhaps we should also accept a
170 * message describing the purpose of the child. Also indicate
171 * this to the caller so that they know something went wrong. */
172 if (waited_pid < 0) {
173 rsyserr(FERROR, errno, "waitpid");
174 *exit_code_ptr = RERR_WAITCHILD;
175 } else if (!WIFEXITED(status)) {
177 if (WCOREDUMP(status))
178 *exit_code_ptr = RERR_CRASHED;
181 if (WIFSIGNALED(status))
182 *exit_code_ptr = RERR_TERMINATED;
184 *exit_code_ptr = RERR_WAITCHILD;
186 *exit_code_ptr = WEXITSTATUS(status);
189 void write_del_stats(int f)
192 write_int(f, NDX_DEL_STATS);
194 write_ndx(f, NDX_DEL_STATS);
195 write_varint(f, stats.deleted_files - stats.deleted_dirs
196 - stats.deleted_symlinks - stats.deleted_devices
197 - stats.deleted_specials);
198 write_varint(f, stats.deleted_dirs);
199 write_varint(f, stats.deleted_symlinks);
200 write_varint(f, stats.deleted_devices);
201 write_varint(f, stats.deleted_specials);
204 void read_del_stats(int f)
206 stats.deleted_files = read_varint(f);
207 stats.deleted_files += stats.deleted_dirs = read_varint(f);
208 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
209 stats.deleted_files += stats.deleted_devices = read_varint(f);
210 stats.deleted_files += stats.deleted_specials = read_varint(f);
213 /* This function gets called from all 3 processes. We want the client side
214 * to actually output the text, but the sender is the only process that has
215 * all the stats we need. So, if we're a client sender, we do the report.
216 * If we're a server sender, we write the stats on the supplied fd. If
217 * we're the client receiver we read the stats from the supplied fd and do
218 * the report. All processes might also generate a set of debug stats, if
219 * the verbose level is high enough (this is the only thing that the
220 * generator process and the server receiver ever do here). */
221 static void handle_stats(int f)
223 endtime = time(NULL);
225 /* Cache two stats because the read/write code can change it. */
226 total_read = stats.total_read;
227 total_written = stats.total_written;
229 if (INFO_GTE(STATS, 3)) {
230 /* These come out from every process */
239 if (f == -1 || !am_sender)
245 write_varlong30(f, total_read, 3);
246 write_varlong30(f, total_written, 3);
247 write_varlong30(f, stats.total_size, 3);
248 if (protocol_version >= 29) {
249 write_varlong30(f, stats.flist_buildtime, 3);
250 write_varlong30(f, stats.flist_xfertime, 3);
256 /* this is the client */
258 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
260 else if (!am_sender) {
261 /* Read the first two in opposite order because the meaning of
262 * read/write swaps when switching from sender to receiver. */
263 total_written = read_varlong30(f, 3);
264 total_read = read_varlong30(f, 3);
265 stats.total_size = read_varlong30(f, 3);
266 if (protocol_version >= 29) {
267 stats.flist_buildtime = read_varlong30(f, 3);
268 stats.flist_xfertime = read_varlong30(f, 3);
270 } else if (write_batch) {
271 /* The --read-batch process is going to be a client
272 * receiver, so we need to give it the stats. */
273 write_varlong30(batch_fd, total_read, 3);
274 write_varlong30(batch_fd, total_written, 3);
275 write_varlong30(batch_fd, stats.total_size, 3);
276 if (protocol_version >= 29) {
277 write_varlong30(batch_fd, stats.flist_buildtime, 3);
278 write_varlong30(batch_fd, stats.flist_xfertime, 3);
283 static void output_itemized_counts(const char *prefix, int *counts)
285 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
286 char buf[1024], *pre = " (";
288 int total = counts[0];
290 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
291 for (j = 0; j < 5; j++) {
293 len += snprintf(buf+len, sizeof buf - len - 2,
295 pre, labels[j], comma_num(counts[j]));
302 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
305 static const char *bytes_per_sec_human_dnum(void)
307 if (starttime == (time_t)-1 || endtime == (time_t)-1)
309 return human_dnum((total_written + total_read) / (0.5 + (endtime - starttime)), 2);
312 static void output_summary(void)
314 if (INFO_GTE(STATS, 2)) {
315 rprintf(FCLIENT, "\n");
316 output_itemized_counts("Number of files", &stats.num_files);
317 if (protocol_version >= 29)
318 output_itemized_counts("Number of created files", &stats.created_files);
319 if (protocol_version >= 31)
320 output_itemized_counts("Number of deleted files", &stats.deleted_files);
321 rprintf(FINFO,"Number of regular files transferred: %s\n",
322 comma_num(stats.xferred_files));
323 rprintf(FINFO,"Total file size: %s bytes\n",
324 human_num(stats.total_size));
325 rprintf(FINFO,"Total transferred file size: %s bytes\n",
326 human_num(stats.total_transferred_size));
327 rprintf(FINFO,"Literal data: %s bytes\n",
328 human_num(stats.literal_data));
329 rprintf(FINFO,"Matched data: %s bytes\n",
330 human_num(stats.matched_data));
331 rprintf(FINFO,"File list size: %s\n",
332 human_num(stats.flist_size));
333 if (stats.flist_buildtime) {
335 "File list generation time: %s seconds\n",
336 comma_dnum((double)stats.flist_buildtime / 1000, 3));
338 "File list transfer time: %s seconds\n",
339 comma_dnum((double)stats.flist_xfertime / 1000, 3));
341 rprintf(FINFO,"Total bytes sent: %s\n",
342 human_num(total_written));
343 rprintf(FINFO,"Total bytes received: %s\n",
344 human_num(total_read));
347 if (INFO_GTE(STATS, 1)) {
348 rprintf(FCLIENT, "\n");
350 "sent %s bytes received %s bytes %s bytes/sec\n",
351 human_num(total_written), human_num(total_read),
352 bytes_per_sec_human_dnum());
353 rprintf(FINFO, "total size is %s speedup is %s%s\n",
354 human_num(stats.total_size),
355 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
356 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
365 * If our C library can get malloc statistics, then show them to FINFO
367 static void show_malloc_stats(void)
374 rprintf(FCLIENT, "\n");
375 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
376 (int)getpid(), am_server ? "server " : "",
377 am_daemon ? "daemon " : "", who_am_i());
378 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
380 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
382 rprintf(FINFO, " smblks: %10ld\n",
384 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
386 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
388 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
389 (long)mi.arena + mi.hblkhd);
390 rprintf(FINFO, " usmblks: %10ld\n",
392 rprintf(FINFO, " fsmblks: %10ld\n",
394 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
396 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
398 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
400 #endif /* HAVE_MALLINFO */
404 /* Start the remote shell. cmd may be NULL to use the default. */
405 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
406 int *f_in_p, int *f_out_p)
409 char *args[MAX_ARGS], *need_to_free = NULL;
413 if (!read_batch && !local_server) {
414 char *t, *f, in_quote = '\0';
415 char *rsh_env = getenv(RSYNC_RSH_ENV);
420 cmd = need_to_free = strdup(cmd);
424 for (t = f = cmd; *f; f++) {
427 /* Comparison leaves rooms for server_options(). */
428 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
431 while (*f != ' ' || in_quote) {
435 "Missing trailing-%c in remote-shell command.\n",
437 exit_cleanup(RERR_SYNTAX);
442 if (*f == '\'' || *f == '"') {
447 if (*f == in_quote && *++f != in_quote) {
457 /* check to see if we've already been given '-l user' in
458 * the remote-shell command */
459 for (i = 0; i < argc-1; i++) {
460 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
465 /* remsh (on HPUX) takes the arguments the other way around */
466 args[argc++] = machine;
467 if (user && !(daemon_over_rsh && dash_l_set)) {
472 if (user && !(daemon_over_rsh && dash_l_set)) {
476 args[argc++] = machine;
479 args[argc++] = rsync_path;
481 if (blocking_io < 0) {
483 if ((cp = strrchr(cmd, '/')) != NULL)
487 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
491 server_options(args,&argc);
493 if (argc >= MAX_ARGS - 2)
499 if (!daemon_over_rsh) {
500 while (remote_argc > 0) {
501 if (argc >= MAX_ARGS - 1) {
503 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
504 exit_cleanup(RERR_SYNTAX);
506 if (**remote_argv == '-') {
507 if (asprintf(args + argc++, "./%s", *remote_argv++) < 0)
508 out_of_memory("do_cmd");
510 args[argc++] = *remote_argv++;
517 if (DEBUG_GTE(CMD, 2)) {
518 for (i = 0; i < argc; i++)
519 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
520 rprintf(FCLIENT, "\n");
524 int from_gen_pipe[2];
525 set_allow_inc_recurse();
526 if (fd_pair(from_gen_pipe) < 0) {
527 rsyserr(FERROR, errno, "pipe");
528 exit_cleanup(RERR_IPC);
530 batch_gen_fd = from_gen_pipe[0];
531 *f_out_p = from_gen_pipe[1];
533 pid = (pid_t)-1; /* no child pid */
537 } else if (local_server) {
538 /* If the user didn't request --[no-]whole-file, force
539 * it on, but only if we're not batch processing. */
540 if (whole_file < 0 && !write_batch)
542 set_allow_inc_recurse();
543 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
548 pid = piped_child(args, f_in_p, f_out_p);
552 if (protect_args && !daemon_over_rsh)
553 send_protected_args(*f_out_p, args);
562 out_of_memory("do_cmd");
563 return 0; /* not reached */
566 /* The receiving side operates in one of two modes:
568 * 1. it receives any number of files into a destination directory,
569 * placing them according to their names in the file-list.
571 * 2. it receives a single file and saves it using the name in the
572 * destination path instead of its file-list name. This requires a
573 * "local name" for writing out the destination file.
575 * So, our task is to figure out what mode/local-name we need.
576 * For mode 1, we change into the destination directory and return NULL.
577 * For mode 2, we change into the directory containing the destination
578 * file (if we aren't already there) and return the local-name. */
579 static char *get_local_name(struct file_list *flist, char *dest_path)
585 if (DEBUG_GTE(RECV, 1)) {
586 rprintf(FINFO, "get_local_name count=%d %s\n",
587 file_total, NS(dest_path));
590 if (!dest_path || list_only)
593 /* Treat an empty string as a copy into the current directory. */
597 if (daemon_filter_list.head) {
598 char *slash = strrchr(dest_path, '/');
599 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
603 if ((*dest_path != '.' || dest_path[1] != '\0')
604 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
605 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
606 rprintf(FERROR, "ERROR: daemon has excluded destination \"%s\"\n",
608 exit_cleanup(RERR_FILESELECT);
614 /* See what currently exists at the destination. */
615 if ((statret = do_stat(dest_path, &st)) == 0) {
616 /* If the destination is a dir, enter it and use mode 1. */
617 if (S_ISDIR(st.st_mode)) {
618 if (!change_dir(dest_path, CD_NORMAL)) {
619 rsyserr(FERROR, errno, "change_dir#1 %s failed",
620 full_fname(dest_path));
621 exit_cleanup(RERR_FILESELECT);
623 filesystem_dev = st.st_dev; /* ensures --force works right w/-x */
626 if (file_total > 1) {
628 "ERROR: destination must be a directory when"
629 " copying more than 1 file\n");
630 exit_cleanup(RERR_FILESELECT);
632 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
634 "ERROR: cannot overwrite non-directory"
635 " with a directory\n");
636 exit_cleanup(RERR_FILESELECT);
638 } else if (errno != ENOENT) {
639 /* If we don't know what's at the destination, fail. */
640 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
641 full_fname(dest_path));
642 exit_cleanup(RERR_FILESELECT);
645 cp = strrchr(dest_path, '/');
647 /* If we need a destination directory because the transfer is not
648 * of a single non-directory or the user has requested one via a
649 * destination path ending in a slash, create one and use mode 1. */
650 if (file_total > 1 || (cp && !cp[1])) {
651 /* Lop off the final slash (if any). */
657 "ERROR: destination path is not a directory\n");
658 exit_cleanup(RERR_SYNTAX);
661 if (do_mkdir(dest_path, ACCESSPERMS) != 0) {
662 rsyserr(FERROR, errno, "mkdir %s failed",
663 full_fname(dest_path));
664 exit_cleanup(RERR_FILEIO);
667 if (flist->high >= flist->low
668 && strcmp(flist->files[flist->low]->basename, ".") == 0)
669 flist->files[0]->flags |= FLAG_DIR_CREATED;
671 if (INFO_GTE(NAME, 1))
672 rprintf(FINFO, "created directory %s\n", dest_path);
675 /* Indicate that dest dir doesn't really exist. */
679 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
680 rsyserr(FERROR, errno, "change_dir#2 %s failed",
681 full_fname(dest_path));
682 exit_cleanup(RERR_FILESELECT);
688 /* Otherwise, we are writing a single file, possibly on top of an
689 * existing non-directory. Change to the item's parent directory
690 * (if it has a path component), return the basename of the
691 * destination file as the local name, and use mode 2. */
699 if (!change_dir(dest_path, CD_NORMAL)) {
700 rsyserr(FERROR, errno, "change_dir#3 %s failed",
701 full_fname(dest_path));
702 exit_cleanup(RERR_FILESELECT);
709 /* This function checks on our alternate-basis directories. If we're in
710 * dry-run mode and the destination dir does not yet exist, we'll try to
711 * tweak any dest-relative paths to make them work for a dry-run (the
712 * destination dir must be in curr_dir[] when this function is called).
713 * We also warn about any arg that is non-existent or not a directory. */
714 static void check_alt_basis_dirs(void)
717 char *slash = strrchr(curr_dir, '/');
720 for (j = 0; j < basis_dir_cnt; j++) {
721 char *bdir = basis_dir[j];
722 int bd_len = strlen(bdir);
723 if (bd_len > 1 && bdir[bd_len-1] == '/')
724 bdir[--bd_len] = '\0';
725 if (dry_run > 1 && *bdir != '/') {
726 int len = curr_dir_len + 1 + bd_len + 1;
727 char *new = new_array(char, len);
729 out_of_memory("check_alt_basis_dirs");
730 if (slash && strncmp(bdir, "../", 3) == 0) {
731 /* We want to remove only one leading "../" prefix for
732 * the directory we couldn't create in dry-run mode:
733 * this ensures that any other ".." references get
734 * evaluated the same as they would for a live copy. */
736 pathjoin(new, len, curr_dir, bdir + 3);
739 pathjoin(new, len, curr_dir, bdir);
740 basis_dir[j] = bdir = new;
742 if (do_stat(bdir, &st) < 0)
743 rprintf(FWARNING, "%s arg does not exist: %s\n", dest_option, bdir);
744 else if (!S_ISDIR(st.st_mode))
745 rprintf(FWARNING, "%s arg is not a dir: %s\n", dest_option, bdir);
749 /* This is only called by the sender. */
750 static void read_final_goodbye(int f_in, int f_out)
754 char xname[MAXPATHLEN];
756 shutting_down = True;
758 if (protocol_version < 29)
761 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
762 if (protocol_version >= 31 && i == NDX_DONE) {
764 write_ndx(f_out, NDX_DONE);
766 if (batch_gen_fd >= 0) {
767 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
768 read_del_stats(batch_gen_fd);
770 write_int(f_out, NDX_DONE);
772 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
777 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
779 exit_cleanup(RERR_PROTOCOL);
783 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
785 struct file_list *flist;
788 if (DEBUG_GTE(SEND, 1))
789 rprintf(FINFO, "server_sender starting pid=%d\n", (int)getpid());
791 if (am_daemon && lp_write_only(module_id)) {
792 rprintf(FERROR, "ERROR: module is write only\n");
793 exit_cleanup(RERR_SYNTAX);
795 if (am_daemon && read_only && remove_source_files) {
797 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
798 remove_source_files == 1 ? "source" : "sent");
799 exit_cleanup(RERR_SYNTAX);
802 rprintf(FERROR, "ERROR: do_server_sender called without args\n");
803 exit_cleanup(RERR_SYNTAX);
807 if (!relative_paths) {
808 if (!change_dir(dir, CD_NORMAL)) {
809 rsyserr(FERROR, errno, "change_dir#3 %s failed",
811 exit_cleanup(RERR_FILESELECT);
817 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
823 flist = send_file_list(f_out,argc,argv);
824 if (!flist || flist->used == 0) {
825 /* Make sure input buffering is off so we can't hang in noop_io_until_death(). */
826 io_end_buffering_in(0);
827 /* TODO: we should really exit in a more controlled manner. */
831 io_start_buffering_in(f_in);
833 send_files(f_in, f_out);
834 io_flush(FULL_FLUSH);
836 if (protocol_version >= 24)
837 read_final_goodbye(f_in, f_out);
838 io_flush(FULL_FLUSH);
843 static int do_recv(int f_in, int f_out, char *local_name)
849 /* The receiving side mustn't obey this, or an existing symlink that
850 * points to an identical file won't be replaced by the referent. */
851 copy_links = copy_dirlinks = copy_unsafe_links = 0;
853 #ifdef SUPPORT_HARD_LINKS
854 if (preserve_hard_links && !inc_recurse)
855 match_hard_links(first_flist);
858 if (fd_pair(error_pipe) < 0) {
859 rsyserr(FERROR, errno, "pipe failed in do_recv");
860 exit_cleanup(RERR_IPC);
866 if (backup_dir_len > 1)
867 backup_dir_buf[backup_dir_len-1] = '\0';
868 ret = do_stat(backup_dir_buf, &st);
869 if (ret != 0 || !S_ISDIR(st.st_mode)) {
871 rprintf(FERROR, "The backup-dir is not a directory: %s\n", backup_dir_buf);
872 exit_cleanup(RERR_SYNTAX);
874 if (errno != ENOENT) {
875 rprintf(FERROR, "Failed to stat %s: %s\n", backup_dir_buf, strerror(errno));
876 exit_cleanup(RERR_FILEIO);
878 if (INFO_GTE(BACKUP, 1))
879 rprintf(FINFO, "(new) backup_dir is %s\n", backup_dir_buf);
880 } else if (INFO_GTE(BACKUP, 1))
881 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
882 if (backup_dir_len > 1)
883 backup_dir_buf[backup_dir_len-1] = '/';
886 io_flush(FULL_FLUSH);
888 if ((pid = do_fork()) == -1) {
889 rsyserr(FERROR, errno, "fork failed in do_recv");
890 exit_cleanup(RERR_IPC);
895 send_msgs_to_gen = am_server;
897 close(error_pipe[0]);
899 /* We can't let two processes write to the socket at one time. */
900 io_end_multiplex_out(MPLX_SWITCHING);
904 f_out = error_pipe[1];
906 bwlimit_writemax = 0; /* receiver doesn't need to do this */
909 io_start_buffering_in(f_in);
910 io_start_multiplex_out(f_out);
912 recv_files(f_in, f_out, local_name);
913 io_flush(FULL_FLUSH);
916 if (output_needs_newline) {
918 output_needs_newline = 0;
921 write_int(f_out, NDX_DONE);
922 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
923 io_flush(FULL_FLUSH);
925 /* Handle any keep-alive packets from the post-processing work
926 * that the generator does. */
927 if (protocol_version >= 29) {
928 kluge_around_eof = -1;
930 /* This should only get stopped via a USR2 signal. */
931 read_final_goodbye(f_in, f_out);
933 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
935 exit_cleanup(RERR_PROTOCOL);
938 /* Finally, we go to sleep until our parent kills us with a
939 * USR2 signal. We sleep for a short time, as on some OSes
940 * a signal won't interrupt a sleep! */
946 flist_receiving_enabled = True;
948 io_end_multiplex_in(MPLX_SWITCHING);
949 if (write_batch && !am_server)
952 close(error_pipe[1]);
956 f_in = error_pipe[0];
958 io_start_buffering_out(f_out);
959 io_start_multiplex_in(f_in);
961 #ifdef SUPPORT_HARD_LINKS
962 if (preserve_hard_links && inc_recurse) {
963 struct file_list *flist;
964 for (flist = first_flist; flist; flist = flist->next)
965 match_hard_links(flist);
969 generate_files(f_out, local_name);
972 io_flush(FULL_FLUSH);
973 shutting_down = True;
974 if (protocol_version >= 24) {
975 /* send a final goodbye message */
976 write_ndx(f_out, NDX_DONE);
978 io_flush(FULL_FLUSH);
981 wait_process_with_flush(pid, &exit_code);
985 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
988 struct file_list *flist;
989 char *local_name = NULL;
992 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
993 /* We can't mix messages with files-from data on the socket,
994 * so temporarily turn off info/debug messages. */
995 negate_output_levels();
1000 if (DEBUG_GTE(RECV, 1))
1001 rprintf(FINFO, "server_recv(%d) starting pid=%d\n", argc, (int)getpid());
1003 if (am_daemon && read_only) {
1004 rprintf(FERROR,"ERROR: module is read only\n");
1005 exit_cleanup(RERR_SYNTAX);
1010 char *dir = argv[0];
1013 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
1014 rsyserr(FERROR, errno, "change_dir#4 %s failed",
1016 exit_cleanup(RERR_FILESELECT);
1020 if (protocol_version >= 30)
1021 io_start_multiplex_in(f_in);
1023 io_start_buffering_in(f_in);
1024 recv_filter_list(f_in);
1026 if (filesfrom_fd >= 0) {
1027 /* We need to send the files-from names to the sender at the
1028 * same time that we receive the file-list from them, so we
1029 * need the IO routines to automatically write out the names
1030 * onto our f_out socket as we read the file-list. This
1031 * avoids both deadlock and extra delays/buffers. */
1032 start_filesfrom_forwarding(filesfrom_fd);
1036 flist = recv_file_list(f_in, -1);
1038 rprintf(FERROR,"server_recv: recv_file_list error\n");
1039 exit_cleanup(RERR_FILESELECT);
1041 if (inc_recurse && file_total == 1)
1042 recv_additional_file_list(f_in);
1045 negate_output_levels();
1048 local_name = get_local_name(flist,argv[0]);
1050 /* Now that we know what our destination directory turned out to be,
1051 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1052 if (sanitize_paths) {
1054 for (dir_p = basis_dir; *dir_p; dir_p++)
1055 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1057 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1059 check_alt_basis_dirs();
1061 if (daemon_filter_list.head) {
1063 filter_rule_list *elp = &daemon_filter_list;
1065 for (dir_p = basis_dir; *dir_p; dir_p++) {
1068 dir += module_dirlen;
1069 if (check_filter(elp, FLOG, dir, 1) < 0)
1070 goto options_rejected;
1072 if (partial_dir && *partial_dir == '/'
1073 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1076 "Your options have been rejected by the server.\n");
1077 exit_cleanup(RERR_SYNTAX);
1081 exit_code = do_recv(f_in, f_out, local_name);
1082 exit_cleanup(exit_code);
1086 int child_main(int argc, char *argv[])
1088 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1093 void start_server(int f_in, int f_out, int argc, char *argv[])
1095 set_nonblocking(f_in);
1096 set_nonblocking(f_out);
1098 io_set_sock_fds(f_in, f_out);
1099 setup_protocol(f_out, f_in);
1101 if (protocol_version >= 23)
1102 io_start_multiplex_out(f_out);
1103 if (am_daemon && io_timeout && protocol_version >= 31)
1104 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1107 keep_dirlinks = 0; /* Must be disabled on the sender. */
1108 if (need_messages_from_generator)
1109 io_start_multiplex_in(f_in);
1111 io_start_buffering_in(f_in);
1112 recv_filter_list(f_in);
1113 do_server_sender(f_in, f_out, argc, argv);
1115 do_server_recv(f_in, f_out, argc, argv);
1119 /* This is called once the connection has been negotiated. It is used
1120 * for rsyncd, remote-shell, and local connections. */
1121 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1123 struct file_list *flist = NULL;
1124 int exit_code = 0, exit_code2 = 0;
1125 char *local_name = NULL;
1127 cleanup_child_pid = pid;
1129 set_nonblocking(f_in);
1130 set_nonblocking(f_out);
1133 io_set_sock_fds(f_in, f_out);
1134 setup_protocol(f_out,f_in);
1136 /* We set our stderr file handle to blocking because ssh might have
1137 * set it to non-blocking. This can be particularly troublesome if
1138 * stderr is a clone of stdout, because ssh would have set our stdout
1139 * to non-blocking at the same time (which can easily cause us to lose
1140 * output from our print statements). This kluge shouldn't cause ssh
1141 * any problems for how we use it. Note also that we delayed setting
1142 * this until after the above protocol setup so that we know for sure
1143 * that ssh is done twiddling its file descriptors. */
1144 set_blocking(STDERR_FILENO);
1147 keep_dirlinks = 0; /* Must be disabled on the sender. */
1150 && (log_format_has(stdout_format, 'C')
1151 || log_format_has(logfile_format, 'C')))
1152 sender_keeps_checksum = 1;
1154 if (protocol_version >= 30)
1155 io_start_multiplex_out(f_out);
1157 io_start_buffering_out(f_out);
1158 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1159 io_start_multiplex_in(f_in);
1161 io_start_buffering_in(f_in);
1162 send_filter_list(f_out);
1164 filesfrom_fd = f_in;
1166 if (write_batch && !am_server)
1167 start_write_batch(f_out);
1168 flist = send_file_list(f_out, argc, argv);
1169 if (DEBUG_GTE(FLIST, 3))
1170 rprintf(FINFO,"file list sent\n");
1172 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1173 io_start_multiplex_in(f_in);
1175 io_flush(NORMAL_FLUSH);
1176 send_files(f_in, f_out);
1177 io_flush(FULL_FLUSH);
1179 if (protocol_version >= 24)
1180 read_final_goodbye(f_in, f_out);
1182 if (DEBUG_GTE(EXIT, 2))
1183 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1184 io_flush(FULL_FLUSH);
1185 wait_process_with_flush(pid, &exit_code);
1188 io_flush(FULL_FLUSH);
1189 exit_cleanup(exit_code);
1193 if (protocol_version >= 23)
1194 io_start_multiplex_in(f_in);
1195 if (need_messages_from_generator)
1196 io_start_multiplex_out(f_out);
1198 io_start_buffering_out(f_out);
1201 send_filter_list(read_batch ? -1 : f_out);
1203 if (filesfrom_fd >= 0) {
1204 start_filesfrom_forwarding(filesfrom_fd);
1208 if (write_batch && !am_server)
1209 start_write_batch(f_in);
1210 flist = recv_file_list(f_in, -1);
1211 if (inc_recurse && file_total == 1)
1212 recv_additional_file_list(f_in);
1214 if (flist && flist->used > 0) {
1215 local_name = get_local_name(flist, argv[0]);
1217 check_alt_basis_dirs();
1219 exit_code2 = do_recv(f_in, f_out, local_name);
1226 if (DEBUG_GTE(RECV, 1))
1227 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1228 io_flush(FULL_FLUSH);
1229 wait_process_with_flush(pid, &exit_code);
1232 return MAX(exit_code, exit_code2);
1235 static int copy_argv(char *argv[])
1239 for (i = 0; argv[i]; i++) {
1240 if (!(argv[i] = strdup(argv[i]))) {
1241 rprintf (FERROR, "out of memory at %s(%d)\n",
1242 __FILE__, __LINE__);
1251 /* Start a client for either type of remote connection. Work out
1252 * whether the arguments request a remote shell or rsyncd connection,
1253 * and call the appropriate connection function, then run_client.
1255 * Calls either start_socket_client (for sockets) or do_cmd and
1256 * client_run (for ssh). */
1257 static int start_client(int argc, char *argv[])
1259 char *p, *shell_machine = NULL, *shell_user = NULL;
1266 /* Don't clobber argv[] so that ps(1) can still show the right
1268 if ((ret = copy_argv(argv)) != 0)
1271 if (!read_batch) { /* for read_batch, NO source is specified */
1272 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1273 if (path) { /* source is remote */
1280 if (argc == 1 || **argv == ':')
1281 argc = 0; /* no dest arg */
1282 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1284 "The source and destination cannot both be remote.\n");
1285 exit_cleanup(RERR_SYNTAX);
1287 remote_argc--; /* don't count dest */
1290 if (filesfrom_host && *filesfrom_host
1291 && strcmp(filesfrom_host, shell_machine) != 0) {
1293 "--files-from hostname is not the same as the transfer hostname\n");
1294 exit_cleanup(RERR_SYNTAX);
1298 daemon_over_rsh = shell_cmd ? 1 : -1;
1299 } else { /* source is local, check dest arg */
1304 remote_argv = argv + argc;
1306 static char *dotarg[1] = { "." };
1308 remote_argv = dotarg;
1312 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1313 if (path && filesfrom_host && *filesfrom_host
1314 && strcmp(filesfrom_host, shell_machine) != 0) {
1316 "--files-from hostname is not the same as the transfer hostname\n");
1317 exit_cleanup(RERR_SYNTAX);
1319 if (!path) { /* no hostspec found, so src & dest are local */
1321 if (filesfrom_host) {
1323 "--files-from cannot be remote when the transfer is local\n");
1324 exit_cleanup(RERR_SYNTAX);
1326 shell_machine = NULL;
1327 } else { /* hostspec was found, so dest is remote */
1330 daemon_over_rsh = shell_cmd ? 1 : -1;
1333 } else { /* read_batch */
1335 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1336 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1337 exit_cleanup(RERR_SYNTAX);
1339 remote_argv = argv += argc - 1;
1340 remote_argc = argc = 1;
1343 if (!rsync_port && remote_argc && !**remote_argv) /* Turn an empty arg into a dot dir. */
1348 int dummy_port = rsync_port;
1350 /* For local source, extra source args must not have hostspec. */
1351 for (i = 1; i < argc; i++) {
1352 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1353 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1354 exit_cleanup(RERR_SYNTAX);
1359 int dummy_port = rsync_port;
1361 /* For remote source, any extra source args must have either
1362 * the same hostname or an empty hostname. */
1363 for (i = 1; i < remote_argc; i++) {
1364 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1366 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1367 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1368 exit_cleanup(RERR_SYNTAX);
1370 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1371 rprintf(FERROR, "All source args must come from the same machine.\n");
1372 exit_cleanup(RERR_SYNTAX);
1374 if (rsync_port != dummy_port) {
1375 if (!rsync_port || !dummy_port)
1376 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1378 rprintf(FERROR, "All source args must use the same port number.\n");
1379 exit_cleanup(RERR_SYNTAX);
1381 if (!rsync_port && !*arg) /* Turn an empty arg into a dot dir. */
1383 remote_argv[i] = arg;
1387 if (daemon_over_rsh < 0)
1388 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1390 if (password_file && !daemon_over_rsh) {
1391 rprintf(FERROR, "The --password-file option may only be "
1392 "used when accessing an rsync daemon.\n");
1393 exit_cleanup(RERR_SYNTAX);
1396 if (connect_timeout) {
1397 rprintf(FERROR, "The --contimeout option may only be "
1398 "used when connecting to an rsync daemon.\n");
1399 exit_cleanup(RERR_SYNTAX);
1402 if (shell_machine) {
1403 p = strrchr(shell_machine,'@');
1406 shell_user = shell_machine;
1407 shell_machine = p+1;
1411 if (DEBUG_GTE(CMD, 2)) {
1412 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1413 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1414 NS(remote_argv[0]));
1417 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1420 /* if we're running an rsync server on the remote host over a
1421 * remote shell command, we need to do the RSYNCD protocol first */
1422 if (daemon_over_rsh) {
1424 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1429 ret = client_run(f_in, f_out, pid, argc, argv);
1438 static void sigusr1_handler(UNUSED(int val))
1440 exit_cleanup(RERR_SIGNAL1);
1443 static void sigusr2_handler(UNUSED(int val))
1449 _exit(RERR_PARTIAL);
1453 void remember_children(UNUSED(int val))
1458 /* An empty waitpid() loop was put here by Tridge and we could never
1459 * get him to explain why he put it in, so rather than taking it
1460 * out we're instead saving the child exit statuses for later use.
1461 * The waitpid() loop presumably eliminates all possibility of leaving
1462 * zombie children, maybe that's why he did it. */
1463 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1464 /* save the child's exit status */
1465 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1466 if (pid_stat_table[cnt].pid == 0) {
1467 pid_stat_table[cnt].pid = pid;
1468 pid_stat_table[cnt].status = status;
1474 #ifndef HAVE_SIGACTION
1475 signal(SIGCHLD, remember_children);
1481 * This routine catches signals and tries to send them to gdb.
1483 * Because it's called from inside a signal handler it ought not to
1484 * use too many library routines.
1486 * @todo Perhaps use "screen -X" instead/as well, to help people
1487 * debugging without easy access to X. Perhaps use an environment
1488 * variable, or just call a script?
1490 * @todo The /proc/ magic probably only works on Linux (and
1491 * Solaris?) Can we be more portable?
1493 #ifdef MAINTAINER_MODE
1494 const char *get_panic_action(void)
1496 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1501 return "xterm -display :0 -T Panic -n Panic "
1502 "-e gdb /proc/%d/exe %d";
1507 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1509 * This signal handler is only installed if we were configured with
1510 * --enable-maintainer-mode. Perhaps it should always be on and we
1511 * should just look at the environment variable, but I'm a bit leery
1512 * of a signal sending us into a busy loop.
1514 static void rsync_panic_handler(UNUSED(int whatsig))
1517 int ret, pid_int = getpid();
1519 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(), pid_int, pid_int);
1521 /* Unless we failed to execute gdb, we allow the process to
1522 * continue. I'm not sure if that's right. */
1523 ret = system(cmd_buf);
1530 int main(int argc,char *argv[])
1533 int orig_argc = argc;
1534 char **orig_argv = argv;
1535 #ifdef HAVE_SIGACTION
1536 # ifdef HAVE_SIGPROCMASK
1539 sigemptyset(&sigmask);
1541 sigact.sa_flags = SA_NOCLDSTOP;
1543 SIGACTMASK(SIGUSR1, sigusr1_handler);
1544 SIGACTMASK(SIGUSR2, sigusr2_handler);
1545 SIGACTMASK(SIGCHLD, remember_children);
1546 #ifdef MAINTAINER_MODE
1547 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1548 SIGACTMASK(SIGFPE, rsync_panic_handler);
1549 SIGACTMASK(SIGABRT, rsync_panic_handler);
1550 SIGACTMASK(SIGBUS, rsync_panic_handler);
1553 starttime = time(NULL);
1556 am_root = our_uid == 0;
1558 memset(&stats, 0, sizeof(stats));
1562 exit_cleanup(RERR_SYNTAX);
1565 /* Get the umask for use in permission calculations. We no longer set
1566 * it to zero; that is ugly and pointless now that all the callers that
1567 * relied on it have been reeducated to work with default ACLs. */
1568 umask(orig_umask = umask(0));
1570 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1571 setlocale(LC_CTYPE, "");
1574 if (!parse_arguments(&argc, (const char ***) &argv)) {
1575 /* FIXME: We ought to call the same error-handling
1576 * code here, rather than relying on getopt. */
1578 exit_cleanup(RERR_SYNTAX);
1581 SIGACTMASK(SIGINT, sig_int);
1582 SIGACTMASK(SIGHUP, sig_int);
1583 SIGACTMASK(SIGTERM, sig_int);
1584 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1585 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1588 /* Ignore SIGPIPE; we consistently check error codes and will
1590 SIGACTION(SIGPIPE, SIG_IGN);
1592 SIGACTION(SIGXFSZ, SIG_IGN);
1595 /* Initialize change_dir() here because on some old systems getcwd
1596 * (implemented by forking "pwd" and reading its output) doesn't
1597 * work when there are other child processes. Also, on all systems
1598 * that implement getcwd that way "pwd" can't be found after chroot. */
1599 change_dir(NULL, CD_NORMAL);
1601 if ((write_batch || read_batch) && !am_server) {
1603 write_batch_shell_file(orig_argc, orig_argv, argc);
1605 if (read_batch && strcmp(batch_name, "-") == 0)
1606 batch_fd = STDIN_FILENO;
1608 batch_fd = do_open(batch_name,
1609 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1610 : O_RDONLY, S_IRUSR | S_IWUSR);
1613 rsyserr(FERROR, errno, "Batch file %s open error",
1614 full_fname(batch_name));
1615 exit_cleanup(RERR_FILEIO);
1618 read_stream_flags(batch_fd);
1620 write_stream_flags(batch_fd);
1622 if (write_batch < 0)
1629 } else if (am_daemon)
1630 return daemon_main();
1632 if (am_server && protect_args) {
1633 char buf[MAXPATHLEN];
1635 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1636 if (!parse_arguments(&argc, (const char ***) &argv)) {
1638 exit_cleanup(RERR_SYNTAX);
1644 exit_cleanup(RERR_SYNTAX);
1648 set_nonblocking(STDIN_FILENO);
1649 set_nonblocking(STDOUT_FILENO);
1651 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1652 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1655 ret = start_client(argc, argv);
1657 exit_cleanup(RERR_STARTCLIENT);