2 * The startup routines, including main(), for rsync.
4 * Copyright (C) 1996-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2003-2009 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, visit the http://fsf.org website.
26 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
36 extern int inc_recurse;
37 extern int blocking_io;
38 extern int always_checksum;
39 extern int remove_source_files;
40 extern int output_needs_newline;
41 extern int need_messages_from_generator;
42 extern int kluge_around_eof;
43 extern int got_xfer_error;
44 extern int msgs2stderr;
46 extern int copy_links;
47 extern int copy_dirlinks;
48 extern int copy_unsafe_links;
49 extern int keep_dirlinks;
50 extern int preserve_hard_links;
51 extern int protocol_version;
52 extern int file_total;
55 extern int protect_args;
56 extern int relative_paths;
57 extern int sanitize_paths;
58 extern int curr_dir_depth;
59 extern int curr_dir_len;
61 extern int rsync_port;
62 extern int whole_file;
63 extern int read_batch;
64 extern int write_batch;
66 extern int filesfrom_fd;
67 extern int connect_timeout;
68 extern pid_t cleanup_child_pid;
69 extern unsigned int module_dirlen;
70 extern struct stats stats;
71 extern char *stdout_format;
72 extern char *logfile_format;
73 extern char *filesfrom_host;
74 extern char *partial_dir;
75 extern char *dest_option;
76 extern char *rsync_path;
77 extern char *shell_cmd;
78 extern char *batch_name;
79 extern char *password_file;
80 extern char curr_dir[MAXPATHLEN];
81 extern char *basis_dir[MAX_BASIS_DIRS+1];
82 extern struct file_list *first_flist;
83 extern struct filter_list_struct daemon_filter_list;
88 int daemon_over_rsh = 0;
89 mode_t orig_umask = 0;
90 int batch_gen_fd = -1;
91 int sender_keeps_checksum = 0;
93 /* There's probably never more than at most 2 outstanding child processes,
94 * but set it higher, just in case. */
95 #define MAXCHILDPROCS 7
98 # ifdef HAVE_SIGPROCMASK
99 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
101 # define SIGACTMASK(n,h) SIGACTION(n,h)
103 static struct sigaction sigact;
109 } pid_stat_table[MAXCHILDPROCS];
111 static time_t starttime, endtime;
112 static int64 total_read, total_written;
114 static void show_malloc_stats(void);
116 /* Works like waitpid(), but if we already harvested the child pid in our
117 * remember_children(), we succeed instead of returning an error. */
118 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
123 waited_pid = waitpid(pid, status_ptr, flags);
124 } while (waited_pid == -1 && errno == EINTR);
126 if (waited_pid == -1 && errno == ECHILD) {
127 /* Status of requested child no longer available: check to
128 * see if it was processed by remember_children(). */
130 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
131 if (pid == pid_stat_table[cnt].pid) {
132 *status_ptr = pid_stat_table[cnt].status;
133 pid_stat_table[cnt].pid = 0;
142 /* Wait for a process to exit, calling io_flush while waiting. */
143 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
148 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
150 io_flush(FULL_FLUSH);
153 /* TODO: If the child exited on a signal, then log an
154 * appropriate error message. Perhaps we should also accept a
155 * message describing the purpose of the child. Also indicate
156 * this to the caller so that they know something went wrong. */
157 if (waited_pid < 0) {
158 rsyserr(FERROR, errno, "waitpid");
159 *exit_code_ptr = RERR_WAITCHILD;
160 } else if (!WIFEXITED(status)) {
162 if (WCOREDUMP(status))
163 *exit_code_ptr = RERR_CRASHED;
166 if (WIFSIGNALED(status))
167 *exit_code_ptr = RERR_TERMINATED;
169 *exit_code_ptr = RERR_WAITCHILD;
171 *exit_code_ptr = WEXITSTATUS(status);
174 void write_del_stats(int f)
177 write_int(f, NDX_DEL_STATS);
179 send_msg(MSG_DEL_STATS, "", 0, 0);
180 write_varint(f, stats.deleted_files - stats.deleted_dirs
181 - stats.deleted_symlinks - stats.deleted_devices
182 - stats.deleted_specials);
183 write_varint(f, stats.deleted_dirs);
184 write_varint(f, stats.deleted_symlinks);
185 write_varint(f, stats.deleted_devices);
186 write_varint(f, stats.deleted_specials);
189 void read_del_stats(int f)
191 stats.deleted_files = read_varint(f);
192 stats.deleted_files += stats.deleted_dirs = read_varint(f);
193 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
194 stats.deleted_files += stats.deleted_devices = read_varint(f);
195 stats.deleted_files += stats.deleted_specials = read_varint(f);
198 /* This function gets called from all 3 processes. We want the client side
199 * to actually output the text, but the sender is the only process that has
200 * all the stats we need. So, if we're a client sender, we do the report.
201 * If we're a server sender, we write the stats on the supplied fd. If
202 * we're the client receiver we read the stats from the supplied fd and do
203 * the report. All processes might also generate a set of debug stats, if
204 * the verbose level is high enough (this is the only thing that the
205 * generator process and the server receiver ever do here). */
206 static void handle_stats(int f)
208 endtime = time(NULL);
210 /* Cache two stats because the read/write code can change it. */
211 total_read = stats.total_read;
212 total_written = stats.total_written;
214 if (INFO_GTE(STATS, 3)) {
215 /* These come out from every process */
224 if (f == -1 || !am_sender)
230 write_varlong30(f, total_read, 3);
231 write_varlong30(f, total_written, 3);
232 write_varlong30(f, stats.total_size, 3);
233 if (protocol_version >= 29) {
234 write_varlong30(f, stats.flist_buildtime, 3);
235 write_varlong30(f, stats.flist_xfertime, 3);
241 /* this is the client */
243 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
245 else if (!am_sender) {
246 /* Read the first two in opposite order because the meaning of
247 * read/write swaps when switching from sender to receiver. */
248 total_written = read_varlong30(f, 3);
249 total_read = read_varlong30(f, 3);
250 stats.total_size = read_varlong30(f, 3);
251 if (protocol_version >= 29) {
252 stats.flist_buildtime = read_varlong30(f, 3);
253 stats.flist_xfertime = read_varlong30(f, 3);
255 } else if (write_batch) {
256 /* The --read-batch process is going to be a client
257 * receiver, so we need to give it the stats. */
258 write_varlong30(batch_fd, total_read, 3);
259 write_varlong30(batch_fd, total_written, 3);
260 write_varlong30(batch_fd, stats.total_size, 3);
261 if (protocol_version >= 29) {
262 write_varlong30(batch_fd, stats.flist_buildtime, 3);
263 write_varlong30(batch_fd, stats.flist_xfertime, 3);
268 static void output_itemized_counts(const char *prefix, int *counts)
270 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
271 char buf[1024], *pre = " (";
273 int total = counts[0];
275 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
276 for (j = 0; j < 5; j++) {
278 len += snprintf(buf+len, sizeof buf - len - 2,
280 pre, labels[j], comma_num(counts[j]));
287 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
290 static void output_summary(void)
292 if (INFO_GTE(STATS, 2)) {
293 rprintf(FCLIENT, "\n");
294 output_itemized_counts("Number of files", &stats.num_files);
295 if (protocol_version >= 29)
296 output_itemized_counts("Number of created files", &stats.created_files);
297 if (protocol_version >= 31)
298 output_itemized_counts("Number of deleted files", &stats.deleted_files);
299 rprintf(FINFO,"Number of regular files transferred: %s\n",
300 comma_num(stats.xferred_files));
301 rprintf(FINFO,"Total file size: %s bytes\n",
302 human_num(stats.total_size));
303 rprintf(FINFO,"Total transferred file size: %s bytes\n",
304 human_num(stats.total_transferred_size));
305 rprintf(FINFO,"Literal data: %s bytes\n",
306 human_num(stats.literal_data));
307 rprintf(FINFO,"Matched data: %s bytes\n",
308 human_num(stats.matched_data));
309 rprintf(FINFO,"File list size: %s\n",
310 human_num(stats.flist_size));
311 if (stats.flist_buildtime) {
313 "File list generation time: %s seconds\n",
314 comma_dnum((double)stats.flist_buildtime / 1000, 3));
316 "File list transfer time: %s seconds\n",
317 comma_dnum((double)stats.flist_xfertime / 1000, 3));
319 rprintf(FINFO,"Total bytes sent: %s\n",
320 human_num(total_written));
321 rprintf(FINFO,"Total bytes received: %s\n",
322 human_num(total_read));
325 if (INFO_GTE(STATS, 1)) {
326 rprintf(FCLIENT, "\n");
328 "sent %s bytes received %s bytes %s bytes/sec\n",
329 human_num(total_written), human_num(total_read),
330 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
331 rprintf(FINFO, "total size is %s speedup is %s%s\n",
332 human_num(stats.total_size),
333 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
334 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
343 * If our C library can get malloc statistics, then show them to FINFO
345 static void show_malloc_stats(void)
352 rprintf(FCLIENT, "\n");
353 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
354 getpid(), am_server ? "server " : "",
355 am_daemon ? "daemon " : "", who_am_i());
356 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
358 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
360 rprintf(FINFO, " smblks: %10ld\n",
362 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
364 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
366 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
367 (long)mi.arena + mi.hblkhd);
368 rprintf(FINFO, " usmblks: %10ld\n",
370 rprintf(FINFO, " fsmblks: %10ld\n",
372 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
374 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
376 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
378 #endif /* HAVE_MALLINFO */
382 /* Start the remote shell. cmd may be NULL to use the default. */
383 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
384 int *f_in_p, int *f_out_p)
387 char *args[MAX_ARGS];
391 if (!read_batch && !local_server) {
392 char *t, *f, in_quote = '\0';
393 char *rsh_env = getenv(RSYNC_RSH_ENV);
398 cmd = strdup(cmd); /* MEMORY LEAK */
402 for (t = f = cmd; *f; f++) {
405 /* Comparison leaves rooms for server_options(). */
406 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
409 while (*f != ' ' || in_quote) {
413 "Missing trailing-%c in remote-shell command.\n",
415 exit_cleanup(RERR_SYNTAX);
420 if (*f == '\'' || *f == '"') {
425 if (*f == in_quote && *++f != in_quote) {
435 /* check to see if we've already been given '-l user' in
436 * the remote-shell command */
437 for (i = 0; i < argc-1; i++) {
438 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
443 /* remsh (on HPUX) takes the arguments the other way around */
444 args[argc++] = machine;
445 if (user && !(daemon_over_rsh && dash_l_set)) {
450 if (user && !(daemon_over_rsh && dash_l_set)) {
454 args[argc++] = machine;
457 args[argc++] = rsync_path;
459 if (blocking_io < 0) {
461 if ((cp = strrchr(cmd, '/')) != NULL)
465 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
469 server_options(args,&argc);
471 if (argc >= MAX_ARGS - 2)
477 if (!daemon_over_rsh) {
478 while (remote_argc > 0) {
479 if (argc >= MAX_ARGS - 1) {
481 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
482 exit_cleanup(RERR_SYNTAX);
484 args[argc++] = *remote_argv++;
491 if (DEBUG_GTE(CMD, 2)) {
492 for (i = 0; i < argc; i++)
493 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
494 rprintf(FCLIENT, "\n");
498 int from_gen_pipe[2];
499 set_allow_inc_recurse();
500 if (fd_pair(from_gen_pipe) < 0) {
501 rsyserr(FERROR, errno, "pipe");
502 exit_cleanup(RERR_IPC);
504 batch_gen_fd = from_gen_pipe[0];
505 *f_out_p = from_gen_pipe[1];
507 pid = (pid_t)-1; /* no child pid */
511 } else if (local_server) {
512 /* If the user didn't request --[no-]whole-file, force
513 * it on, but only if we're not batch processing. */
514 if (whole_file < 0 && !write_batch)
516 set_allow_inc_recurse();
517 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
522 pid = piped_child(args, f_in_p, f_out_p);
526 if (protect_args && !daemon_over_rsh)
527 send_protected_args(*f_out_p, args);
533 out_of_memory("do_cmd");
534 return 0; /* not reached */
537 /* The receiving side operates in one of two modes:
539 * 1. it receives any number of files into a destination directory,
540 * placing them according to their names in the file-list.
542 * 2. it receives a single file and saves it using the name in the
543 * destination path instead of its file-list name. This requires a
544 * "local name" for writing out the destination file.
546 * So, our task is to figure out what mode/local-name we need.
547 * For mode 1, we change into the destination directory and return NULL.
548 * For mode 2, we change into the directory containing the destination
549 * file (if we aren't already there) and return the local-name. */
550 static char *get_local_name(struct file_list *flist, char *dest_path)
556 if (DEBUG_GTE(RECV, 1)) {
557 rprintf(FINFO, "get_local_name count=%d %s\n",
558 file_total, NS(dest_path));
561 if (!dest_path || list_only)
564 if (daemon_filter_list.head) {
565 char *slash = strrchr(dest_path, '/');
566 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
570 if ((*dest_path != '.' || dest_path[1] != '\0')
571 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
572 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
573 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
575 exit_cleanup(RERR_FILESELECT);
581 /* See what currently exists at the destination. */
582 if ((statret = do_stat(dest_path, &st)) == 0) {
583 /* If the destination is a dir, enter it and use mode 1. */
584 if (S_ISDIR(st.st_mode)) {
585 if (!change_dir(dest_path, CD_NORMAL)) {
586 rsyserr(FERROR, errno, "change_dir#1 %s failed",
587 full_fname(dest_path));
588 exit_cleanup(RERR_FILESELECT);
592 if (file_total > 1) {
594 "ERROR: destination must be a directory when"
595 " copying more than 1 file\n");
596 exit_cleanup(RERR_FILESELECT);
598 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
600 "ERROR: cannot overwrite non-directory"
601 " with a directory\n");
602 exit_cleanup(RERR_FILESELECT);
604 } else if (errno != ENOENT) {
605 /* If we don't know what's at the destination, fail. */
606 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
607 full_fname(dest_path));
608 exit_cleanup(RERR_FILESELECT);
611 cp = strrchr(dest_path, '/');
613 /* If we need a destination directory because the transfer is not
614 * of a single non-directory or the user has requested one via a
615 * destination path ending in a slash, create one and use mode 1. */
616 if (file_total > 1 || (cp && !cp[1])) {
617 /* Lop off the final slash (if any). */
623 "ERROR: destination path is not a directory\n");
624 exit_cleanup(RERR_SYNTAX);
627 if (mkdir_defmode(dest_path) != 0) {
628 rsyserr(FERROR, errno, "mkdir %s failed",
629 full_fname(dest_path));
630 exit_cleanup(RERR_FILEIO);
633 if (flist->high >= flist->low
634 && strcmp(flist->files[flist->low]->basename, ".") == 0)
635 flist->files[0]->flags |= FLAG_DIR_CREATED;
637 if (INFO_GTE(NAME, 1))
638 rprintf(FINFO, "created directory %s\n", dest_path);
641 /* Indicate that dest dir doesn't really exist. */
645 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
646 rsyserr(FERROR, errno, "change_dir#2 %s failed",
647 full_fname(dest_path));
648 exit_cleanup(RERR_FILESELECT);
654 /* Otherwise, we are writing a single file, possibly on top of an
655 * existing non-directory. Change to the item's parent directory
656 * (if it has a path component), return the basename of the
657 * destination file as the local name, and use mode 2. */
665 if (!change_dir(dest_path, CD_NORMAL)) {
666 rsyserr(FERROR, errno, "change_dir#3 %s failed",
667 full_fname(dest_path));
668 exit_cleanup(RERR_FILESELECT);
675 /* This function checks on our alternate-basis directories. If we're in
676 * dry-run mode and the destination dir does not yet exist, we'll try to
677 * tweak any dest-relative paths to make them work for a dry-run (the
678 * destination dir must be in curr_dir[] when this function is called).
679 * We also warn about any arg that is non-existent or not a directory. */
680 static void check_alt_basis_dirs(void)
683 char **dir_p, *slash = strrchr(curr_dir, '/');
685 for (dir_p = basis_dir; *dir_p; dir_p++) {
686 if (dry_run > 1 && **dir_p != '/') {
687 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
688 char *new = new_array(char, len);
690 out_of_memory("check_alt_basis_dirs");
691 if (slash && strncmp(*dir_p, "../", 3) == 0) {
692 /* We want to remove only one leading "../" prefix for
693 * the directory we couldn't create in dry-run mode:
694 * this ensures that any other ".." references get
695 * evaluated the same as they would for a live copy. */
697 pathjoin(new, len, curr_dir, *dir_p + 3);
700 pathjoin(new, len, curr_dir, *dir_p);
703 if (do_stat(*dir_p, &st) < 0) {
704 rprintf(FWARNING, "%s arg does not exist: %s\n",
705 dest_option, *dir_p);
706 } else if (!S_ISDIR(st.st_mode)) {
707 rprintf(FWARNING, "%s arg is not a dir: %s\n",
708 dest_option, *dir_p);
713 /* This is only called by the sender. */
714 static void read_final_goodbye(int f_in, int f_out)
718 char xname[MAXPATHLEN];
720 if (protocol_version < 29)
723 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type, xname, &xlen);
724 if (protocol_version >= 31 && i == NDX_DONE) {
726 write_ndx(f_out, NDX_DONE);
728 if (batch_gen_fd >= 0) {
729 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
730 read_del_stats(batch_gen_fd);
732 send_msg(MSG_DONE, "", 0, 0);
734 i = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type, xname, &xlen);
739 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
741 exit_cleanup(RERR_PROTOCOL);
745 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
747 struct file_list *flist;
750 if (DEBUG_GTE(SEND, 1)) {
751 rprintf(FINFO, "server_sender starting pid=%ld\n",
755 if (am_daemon && lp_write_only(module_id)) {
756 rprintf(FERROR, "ERROR: module is write only\n");
757 exit_cleanup(RERR_SYNTAX);
760 if (am_daemon && lp_read_only(module_id) && remove_source_files) {
762 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
763 remove_source_files == 1 ? "source" : "sent");
764 exit_cleanup(RERR_SYNTAX);
768 if (!relative_paths) {
769 if (!change_dir(dir, CD_NORMAL)) {
770 rsyserr(FERROR, errno, "change_dir#3 %s failed",
772 exit_cleanup(RERR_FILESELECT);
778 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
784 flist = send_file_list(f_out,argc,argv);
785 if (!flist || flist->used == 0)
788 io_start_buffering_in(f_in);
790 send_files(f_in, f_out);
791 io_flush(FULL_FLUSH);
793 if (protocol_version >= 24)
794 read_final_goodbye(f_in, f_out);
795 io_flush(FULL_FLUSH);
800 static int do_recv(int f_in, int f_out, char *local_name)
806 /* The receiving side mustn't obey this, or an existing symlink that
807 * points to an identical file won't be replaced by the referent. */
808 copy_links = copy_dirlinks = copy_unsafe_links = 0;
810 #ifdef SUPPORT_HARD_LINKS
811 if (preserve_hard_links && !inc_recurse)
812 match_hard_links(first_flist);
815 if (fd_pair(error_pipe) < 0) {
816 rsyserr(FERROR, errno, "pipe failed in do_recv");
817 exit_cleanup(RERR_IPC);
820 io_flush(NORMAL_FLUSH);
822 if ((pid = do_fork()) == -1) {
823 rsyserr(FERROR, errno, "fork failed in do_recv");
824 exit_cleanup(RERR_IPC);
828 close(error_pipe[0]);
832 /* we can't let two processes write to the socket at one time */
833 io_end_multiplex_out();
835 /* set place to send errors */
836 set_msg_fd_out(error_pipe[1]);
837 io_start_buffering_out(error_pipe[1]);
839 recv_files(f_in, local_name);
840 io_flush(FULL_FLUSH);
843 if (output_needs_newline) {
845 output_needs_newline = 0;
848 send_msg(MSG_DONE, "", 1, 0);
849 write_varlong(error_pipe[1], stats.total_read, 3);
850 io_flush(FULL_FLUSH);
852 /* Handle any keep-alive packets from the post-processing work
853 * that the generator does. */
854 if (protocol_version >= 29) {
855 kluge_around_eof = -1;
857 /* This should only get stopped via a USR2 signal. */
858 read_final_goodbye(f_in, f_out);
860 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
862 exit_cleanup(RERR_PROTOCOL);
865 /* Finally, we go to sleep until our parent kills us with a
866 * USR2 signal. We sleep for a short time, as on some OSes
867 * a signal won't interrupt a sleep! */
874 io_end_multiplex_in();
875 if (write_batch && !am_server)
878 close(error_pipe[1]);
882 io_start_buffering_out(f_out);
884 set_msg_fd_in(error_pipe[0]);
885 io_start_buffering_in(error_pipe[0]);
887 #ifdef SUPPORT_HARD_LINKS
888 if (preserve_hard_links && inc_recurse) {
889 struct file_list *flist;
890 for (flist = first_flist; flist; flist = flist->next)
891 match_hard_links(flist);
895 generate_files(f_out, local_name);
898 io_flush(FULL_FLUSH);
899 if (protocol_version >= 24) {
900 /* send a final goodbye message */
901 write_ndx(f_out, NDX_DONE);
903 io_flush(FULL_FLUSH);
907 wait_process_with_flush(pid, &exit_code);
911 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
914 struct file_list *flist;
915 char *local_name = NULL;
918 if (filesfrom_fd >= 0 && !msgs2stderr) {
919 /* We can't mix messages with files-from data on the socket,
920 * so temporarily turn off info/debug messages. */
921 negate_output_levels();
926 if (DEBUG_GTE(RECV, 1)) {
927 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
928 argc, (long)getpid());
931 if (am_daemon && lp_read_only(module_id)) {
932 rprintf(FERROR,"ERROR: module is read only\n");
933 exit_cleanup(RERR_SYNTAX);
941 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
942 rsyserr(FERROR, errno, "change_dir#4 %s failed",
944 exit_cleanup(RERR_FILESELECT);
948 if (protocol_version >= 30)
949 io_start_multiplex_in();
951 io_start_buffering_in(f_in);
952 recv_filter_list(f_in);
954 if (filesfrom_fd >= 0) {
955 /* We need to send the files-from names to the sender at the
956 * same time that we receive the file-list from them, so we
957 * need the IO routines to automatically write out the names
958 * onto our f_out socket as we read the file-list. This
959 * avoids both deadlock and extra delays/buffers. */
960 io_set_filesfrom_fds(filesfrom_fd, f_out);
964 flist = recv_file_list(f_in);
966 rprintf(FERROR,"server_recv: recv_file_list error\n");
967 exit_cleanup(RERR_FILESELECT);
969 if (inc_recurse && file_total == 1)
970 recv_additional_file_list(f_in);
973 negate_output_levels();
976 local_name = get_local_name(flist,argv[0]);
978 /* Now that we know what our destination directory turned out to be,
979 * we can sanitize the --link-/copy-/compare-dest args correctly. */
980 if (sanitize_paths) {
982 for (dir_p = basis_dir; *dir_p; dir_p++)
983 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
985 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
987 check_alt_basis_dirs();
989 if (daemon_filter_list.head) {
991 struct filter_list_struct *elp = &daemon_filter_list;
993 for (dir_p = basis_dir; *dir_p; dir_p++) {
996 dir += module_dirlen;
997 if (check_filter(elp, FLOG, dir, 1) < 0)
998 goto options_rejected;
1000 if (partial_dir && *partial_dir == '/'
1001 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1004 "Your options have been rejected by the server.\n");
1005 exit_cleanup(RERR_SYNTAX);
1009 exit_code = do_recv(f_in, f_out, local_name);
1010 exit_cleanup(exit_code);
1014 int child_main(int argc, char *argv[])
1016 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1021 void start_server(int f_in, int f_out, int argc, char *argv[])
1023 set_nonblocking(f_in);
1024 set_nonblocking(f_out);
1026 io_set_sock_fds(f_in, f_out);
1027 setup_protocol(f_out, f_in);
1029 if (protocol_version >= 23)
1030 io_start_multiplex_out();
1033 keep_dirlinks = 0; /* Must be disabled on the sender. */
1034 if (need_messages_from_generator)
1035 io_start_multiplex_in();
1036 recv_filter_list(f_in);
1037 do_server_sender(f_in, f_out, argc, argv);
1039 do_server_recv(f_in, f_out, argc, argv);
1045 * This is called once the connection has been negotiated. It is used
1046 * for rsyncd, remote-shell, and local connections.
1048 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1050 struct file_list *flist = NULL;
1051 int exit_code = 0, exit_code2 = 0;
1052 char *local_name = NULL;
1054 cleanup_child_pid = pid;
1056 set_nonblocking(f_in);
1057 set_nonblocking(f_out);
1060 io_set_sock_fds(f_in, f_out);
1061 setup_protocol(f_out,f_in);
1063 /* We set our stderr file handle to blocking because ssh might have
1064 * set it to non-blocking. This can be particularly troublesome if
1065 * stderr is a clone of stdout, because ssh would have set our stdout
1066 * to non-blocking at the same time (which can easily cause us to lose
1067 * output from our print statements). This kluge shouldn't cause ssh
1068 * any problems for how we use it. Note also that we delayed setting
1069 * this until after the above protocol setup so that we know for sure
1070 * that ssh is done twiddling its file descriptors. */
1071 set_blocking(STDERR_FILENO);
1074 keep_dirlinks = 0; /* Must be disabled on the sender. */
1077 && (log_format_has(stdout_format, 'C')
1078 || log_format_has(logfile_format, 'C')))
1079 sender_keeps_checksum = 1;
1081 if (protocol_version >= 30)
1082 io_start_multiplex_out();
1084 io_start_buffering_out(f_out);
1085 if (!filesfrom_host)
1086 set_msg_fd_in(f_in);
1087 send_filter_list(f_out);
1089 filesfrom_fd = f_in;
1091 if (write_batch && !am_server)
1092 start_write_batch(f_out);
1093 flist = send_file_list(f_out, argc, argv);
1094 if (DEBUG_GTE(FLIST, 3))
1095 rprintf(FINFO,"file list sent\n");
1097 if (protocol_version >= 23)
1098 io_start_multiplex_in();
1100 io_flush(NORMAL_FLUSH);
1101 send_files(f_in, f_out);
1102 io_flush(FULL_FLUSH);
1104 if (protocol_version >= 24)
1105 read_final_goodbye(f_in, f_out);
1107 if (DEBUG_GTE(EXIT, 2))
1108 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1109 io_flush(FULL_FLUSH);
1110 wait_process_with_flush(pid, &exit_code);
1113 io_flush(FULL_FLUSH);
1114 exit_cleanup(exit_code);
1118 if (protocol_version >= 23)
1119 io_start_multiplex_in();
1120 if (need_messages_from_generator)
1121 io_start_multiplex_out();
1124 send_filter_list(read_batch ? -1 : f_out);
1126 if (filesfrom_fd >= 0) {
1127 io_set_filesfrom_fds(filesfrom_fd, f_out);
1131 if (write_batch && !am_server)
1132 start_write_batch(f_in);
1133 flist = recv_file_list(f_in);
1134 if (inc_recurse && file_total == 1)
1135 recv_additional_file_list(f_in);
1137 if (flist && flist->used > 0) {
1138 local_name = get_local_name(flist, argv[0]);
1140 check_alt_basis_dirs();
1142 exit_code2 = do_recv(f_in, f_out, local_name);
1149 if (DEBUG_GTE(RECV, 1))
1150 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1151 io_flush(FULL_FLUSH);
1152 wait_process_with_flush(pid, &exit_code);
1155 return MAX(exit_code, exit_code2);
1158 static int copy_argv(char *argv[])
1162 for (i = 0; argv[i]; i++) {
1163 if (!(argv[i] = strdup(argv[i]))) {
1164 rprintf (FERROR, "out of memory at %s(%d)\n",
1165 __FILE__, __LINE__);
1175 * Start a client for either type of remote connection. Work out
1176 * whether the arguments request a remote shell or rsyncd connection,
1177 * and call the appropriate connection function, then run_client.
1179 * Calls either start_socket_client (for sockets) or do_cmd and
1180 * client_run (for ssh).
1182 static int start_client(int argc, char *argv[])
1184 char *p, *shell_machine = NULL, *shell_user = NULL;
1191 /* Don't clobber argv[] so that ps(1) can still show the right
1193 if ((ret = copy_argv(argv)) != 0)
1196 if (!read_batch) { /* for read_batch, NO source is specified */
1197 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1198 if (path) { /* source is remote */
1205 if (argc == 1 || **argv == ':')
1206 argc = 0; /* no dest arg */
1207 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1209 "The source and destination cannot both be remote.\n");
1210 exit_cleanup(RERR_SYNTAX);
1212 remote_argc--; /* don't count dest */
1215 if (filesfrom_host && *filesfrom_host
1216 && strcmp(filesfrom_host, shell_machine) != 0) {
1218 "--files-from hostname is not the same as the transfer hostname\n");
1219 exit_cleanup(RERR_SYNTAX);
1223 daemon_over_rsh = shell_cmd ? 1 : -1;
1224 } else { /* source is local, check dest arg */
1229 remote_argv = argv + argc;
1231 static char *dotarg[1] = { "." };
1233 remote_argv = dotarg;
1237 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1238 if (path && filesfrom_host && *filesfrom_host
1239 && strcmp(filesfrom_host, shell_machine) != 0) {
1241 "--files-from hostname is not the same as the transfer hostname\n");
1242 exit_cleanup(RERR_SYNTAX);
1244 if (!path) { /* no hostspec found, so src & dest are local */
1246 if (filesfrom_host) {
1248 "--files-from cannot be remote when the transfer is local\n");
1249 exit_cleanup(RERR_SYNTAX);
1251 shell_machine = NULL;
1252 } else { /* hostspec was found, so dest is remote */
1255 daemon_over_rsh = shell_cmd ? 1 : -1;
1258 } else { /* read_batch */
1260 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1261 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1262 exit_cleanup(RERR_SYNTAX);
1264 remote_argv = argv += argc - 1;
1265 remote_argc = argc = 1;
1270 int dummy_port = rsync_port;
1272 /* For local source, extra source args must not have hostspec. */
1273 for (i = 1; i < argc; i++) {
1274 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1275 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1276 exit_cleanup(RERR_SYNTAX);
1281 int dummy_port = rsync_port;
1283 /* For remote source, any extra source args must have either
1284 * the same hostname or an empty hostname. */
1285 for (i = 1; i < remote_argc; i++) {
1286 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1288 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1289 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1290 exit_cleanup(RERR_SYNTAX);
1292 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1293 rprintf(FERROR, "All source args must come from the same machine.\n");
1294 exit_cleanup(RERR_SYNTAX);
1296 if (rsync_port != dummy_port) {
1297 if (!rsync_port || !dummy_port)
1298 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1300 rprintf(FERROR, "All source args must use the same port number.\n");
1301 exit_cleanup(RERR_SYNTAX);
1303 remote_argv[i] = arg;
1307 if (daemon_over_rsh < 0)
1308 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1310 if (password_file && !daemon_over_rsh) {
1311 rprintf(FERROR, "The --password-file option may only be "
1312 "used when accessing an rsync daemon.\n");
1313 exit_cleanup(RERR_SYNTAX);
1316 if (connect_timeout) {
1317 rprintf(FERROR, "The --contimeout option may only be "
1318 "used when connecting to an rsync daemon.\n");
1319 exit_cleanup(RERR_SYNTAX);
1322 if (shell_machine) {
1323 p = strrchr(shell_machine,'@');
1326 shell_user = shell_machine;
1327 shell_machine = p+1;
1331 if (DEBUG_GTE(CMD, 2)) {
1332 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1333 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1334 remote_argv ? NS(remote_argv[0]) : "");
1337 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1340 /* if we're running an rsync server on the remote host over a
1341 * remote shell command, we need to do the RSYNCD protocol first */
1342 if (daemon_over_rsh) {
1344 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1349 ret = client_run(f_in, f_out, pid, argc, argv);
1358 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1360 exit_cleanup(RERR_SIGNAL1);
1363 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1369 _exit(RERR_PARTIAL);
1373 RETSIGTYPE remember_children(UNUSED(int val))
1378 /* An empty waitpid() loop was put here by Tridge and we could never
1379 * get him to explain why he put it in, so rather than taking it
1380 * out we're instead saving the child exit statuses for later use.
1381 * The waitpid() loop presumably eliminates all possibility of leaving
1382 * zombie children, maybe that's why he did it. */
1383 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1384 /* save the child's exit status */
1385 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1386 if (pid_stat_table[cnt].pid == 0) {
1387 pid_stat_table[cnt].pid = pid;
1388 pid_stat_table[cnt].status = status;
1394 #ifndef HAVE_SIGACTION
1395 signal(SIGCHLD, remember_children);
1401 * This routine catches signals and tries to send them to gdb.
1403 * Because it's called from inside a signal handler it ought not to
1404 * use too many library routines.
1406 * @todo Perhaps use "screen -X" instead/as well, to help people
1407 * debugging without easy access to X. Perhaps use an environment
1408 * variable, or just call a script?
1410 * @todo The /proc/ magic probably only works on Linux (and
1411 * Solaris?) Can we be more portable?
1413 #ifdef MAINTAINER_MODE
1414 const char *get_panic_action(void)
1416 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1421 return "xterm -display :0 -T Panic -n Panic "
1422 "-e gdb /proc/%d/exe %d";
1427 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1429 * This signal handler is only installed if we were configured with
1430 * --enable-maintainer-mode. Perhaps it should always be on and we
1431 * should just look at the environment variable, but I'm a bit leery
1432 * of a signal sending us into a busy loop.
1434 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1439 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1440 getpid(), getpid());
1442 /* Unless we failed to execute gdb, we allow the process to
1443 * continue. I'm not sure if that's right. */
1444 ret = system(cmd_buf);
1451 int main(int argc,char *argv[])
1454 int orig_argc = argc;
1455 char **orig_argv = argv;
1456 #ifdef HAVE_SIGACTION
1457 # ifdef HAVE_SIGPROCMASK
1460 sigemptyset(&sigmask);
1462 sigact.sa_flags = SA_NOCLDSTOP;
1464 SIGACTMASK(SIGUSR1, sigusr1_handler);
1465 SIGACTMASK(SIGUSR2, sigusr2_handler);
1466 SIGACTMASK(SIGCHLD, remember_children);
1467 #ifdef MAINTAINER_MODE
1468 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1469 SIGACTMASK(SIGFPE, rsync_panic_handler);
1470 SIGACTMASK(SIGABRT, rsync_panic_handler);
1471 SIGACTMASK(SIGBUS, rsync_panic_handler);
1474 starttime = time(NULL);
1476 am_root = our_uid == 0;
1478 memset(&stats, 0, sizeof(stats));
1482 exit_cleanup(RERR_SYNTAX);
1485 /* we set a 0 umask so that correct file permissions can be
1487 orig_umask = umask(0);
1489 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1490 setlocale(LC_CTYPE, "");
1493 if (!parse_arguments(&argc, (const char ***) &argv)) {
1494 /* FIXME: We ought to call the same error-handling
1495 * code here, rather than relying on getopt. */
1497 exit_cleanup(RERR_SYNTAX);
1500 SIGACTMASK(SIGINT, sig_int);
1501 SIGACTMASK(SIGHUP, sig_int);
1502 SIGACTMASK(SIGTERM, sig_int);
1503 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1504 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1507 /* Ignore SIGPIPE; we consistently check error codes and will
1509 SIGACTION(SIGPIPE, SIG_IGN);
1511 SIGACTION(SIGXFSZ, SIG_IGN);
1514 /* Initialize change_dir() here because on some old systems getcwd
1515 * (implemented by forking "pwd" and reading its output) doesn't
1516 * work when there are other child processes. Also, on all systems
1517 * that implement getcwd that way "pwd" can't be found after chroot. */
1518 change_dir(NULL, CD_NORMAL);
1522 if ((write_batch || read_batch) && !am_server) {
1524 write_batch_shell_file(orig_argc, orig_argv, argc);
1526 if (read_batch && strcmp(batch_name, "-") == 0)
1527 batch_fd = STDIN_FILENO;
1529 batch_fd = do_open(batch_name,
1530 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1531 : O_RDONLY, S_IRUSR | S_IWUSR);
1534 rsyserr(FERROR, errno, "Batch file %s open error",
1535 full_fname(batch_name));
1536 exit_cleanup(RERR_FILEIO);
1539 read_stream_flags(batch_fd);
1541 write_stream_flags(batch_fd);
1543 if (write_batch < 0)
1550 } else if (am_daemon)
1551 return daemon_main();
1553 if (am_server && protect_args) {
1554 char buf[MAXPATHLEN];
1556 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1557 if (!parse_arguments(&argc, (const char ***) &argv)) {
1559 exit_cleanup(RERR_SYNTAX);
1565 exit_cleanup(RERR_SYNTAX);
1569 set_nonblocking(STDIN_FILENO);
1570 set_nonblocking(STDOUT_FILENO);
1572 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1573 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1576 ret = start_client(argc, argv);
1578 exit_cleanup(RERR_STARTCLIENT);