Preparing for release of 3.2.4pre3
[rsync.git] / main.c
blob58920a2d62b94bdd800f273a3edbfd4dfc4d4210
1 /*
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-2022 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.
23 #include "rsync.h"
24 #include "inums.h"
25 #include "ifuncs.h"
26 #include "io.h"
27 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
28 #include <locale.h>
29 #endif
30 #include <popt.h>
31 #ifdef __TANDEM
32 #include <floss.h(floss_execlp)>
33 #endif
35 extern int dry_run;
36 extern int list_only;
37 extern int io_timeout;
38 extern int am_root;
39 extern int am_server;
40 extern int am_sender;
41 extern int am_daemon;
42 extern int inc_recurse;
43 extern int blocking_io;
44 extern int always_checksum;
45 extern int remove_source_files;
46 extern int output_needs_newline;
47 extern int called_from_signal_handler;
48 extern int need_messages_from_generator;
49 extern int kluge_around_eof;
50 extern int got_xfer_error;
51 extern int old_style_args;
52 extern int msgs2stderr;
53 extern int module_id;
54 extern int read_only;
55 extern int copy_links;
56 extern int copy_dirlinks;
57 extern int copy_unsafe_links;
58 extern int keep_dirlinks;
59 extern int preserve_hard_links;
60 extern int protocol_version;
61 extern int mkpath_dest_arg;
62 extern int file_total;
63 extern int recurse;
64 extern int xfer_dirs;
65 extern int protect_args;
66 extern int relative_paths;
67 extern int sanitize_paths;
68 extern int curr_dir_depth;
69 extern int curr_dir_len;
70 extern int module_id;
71 extern int rsync_port;
72 extern int whole_file;
73 extern int read_batch;
74 extern int write_batch;
75 extern int batch_fd;
76 extern int sock_f_in;
77 extern int sock_f_out;
78 extern int filesfrom_fd;
79 extern int connect_timeout;
80 extern int send_msgs_to_gen;
81 extern dev_t filesystem_dev;
82 extern pid_t cleanup_child_pid;
83 extern size_t bwlimit_writemax;
84 extern unsigned int module_dirlen;
85 extern BOOL flist_receiving_enabled;
86 extern BOOL want_progress_now;
87 extern BOOL shutting_down;
88 extern int backup_dir_len;
89 extern int basis_dir_cnt;
90 extern int default_af_hint;
91 extern int stdout_format_has_i;
92 extern struct stats stats;
93 extern char *stdout_format;
94 extern char *logfile_format;
95 extern char *filesfrom_host;
96 extern char *partial_dir;
97 extern char *rsync_path;
98 extern char *shell_cmd;
99 extern char *password_file;
100 extern char *backup_dir;
101 extern char *copy_as;
102 extern char *tmpdir;
103 extern char curr_dir[MAXPATHLEN];
104 extern char backup_dir_buf[MAXPATHLEN];
105 extern char *basis_dir[MAX_BASIS_DIRS+1];
106 extern struct file_list *first_flist;
107 extern filter_rule_list daemon_filter_list;
109 uid_t our_uid;
110 gid_t our_gid;
111 int am_receiver = 0; /* Only set to 1 after the receiver/generator fork. */
112 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
113 int local_server = 0;
114 int daemon_connection = 0; /* 0 = no daemon, 1 = daemon via remote shell, -1 = daemon via socket */
115 mode_t orig_umask = 0;
116 int batch_gen_fd = -1;
117 int sender_keeps_checksum = 0;
118 int raw_argc, cooked_argc;
119 char **raw_argv, **cooked_argv;
121 /* There's probably never more than at most 2 outstanding child processes,
122 * but set it higher, just in case. */
123 #define MAXCHILDPROCS 7
125 #ifdef HAVE_SIGACTION
126 # ifdef HAVE_SIGPROCMASK
127 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
128 # else
129 # define SIGACTMASK(n,h) SIGACTION(n,h)
130 # endif
131 static struct sigaction sigact;
132 #endif
134 struct pid_status {
135 pid_t pid;
136 int status;
137 } pid_stat_table[MAXCHILDPROCS];
139 static time_t starttime, endtime;
140 static int64 total_read, total_written;
142 static void show_malloc_stats(void);
144 /* Works like waitpid(), but if we already harvested the child pid in our
145 * remember_children(), we succeed instead of returning an error. */
146 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
148 pid_t waited_pid;
150 do {
151 waited_pid = waitpid(pid, status_ptr, flags);
152 } while (waited_pid == -1 && errno == EINTR);
154 if (waited_pid == -1 && errno == ECHILD) {
155 /* Status of requested child no longer available: check to
156 * see if it was processed by remember_children(). */
157 int cnt;
158 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
159 if (pid == pid_stat_table[cnt].pid) {
160 *status_ptr = pid_stat_table[cnt].status;
161 pid_stat_table[cnt].pid = 0;
162 return pid;
167 return waited_pid;
170 int shell_exec(const char *cmd)
172 char *shell = getenv("RSYNC_SHELL");
173 int status;
174 pid_t pid;
176 if (!shell)
177 return system(cmd);
179 if ((pid = fork()) < 0)
180 return -1;
182 if (pid == 0) {
183 execlp(shell, shell, "-c", cmd, NULL);
184 _exit(1);
187 int ret = wait_process(pid, &status, 0);
188 return ret < 0 ? -1 : status;
191 /* Wait for a process to exit, calling io_flush while waiting. */
192 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
194 pid_t waited_pid;
195 int status;
197 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
198 msleep(20);
199 io_flush(FULL_FLUSH);
202 /* TODO: If the child exited on a signal, then log an
203 * appropriate error message. Perhaps we should also accept a
204 * message describing the purpose of the child. Also indicate
205 * this to the caller so that they know something went wrong. */
206 if (waited_pid < 0) {
207 rsyserr(FERROR, errno, "waitpid");
208 *exit_code_ptr = RERR_WAITCHILD;
209 } else if (!WIFEXITED(status)) {
210 #ifdef WCOREDUMP
211 if (WCOREDUMP(status))
212 *exit_code_ptr = RERR_CRASHED;
213 else
214 #endif
215 if (WIFSIGNALED(status))
216 *exit_code_ptr = RERR_TERMINATED;
217 else
218 *exit_code_ptr = RERR_WAITCHILD;
219 } else
220 *exit_code_ptr = WEXITSTATUS(status);
223 void write_del_stats(int f)
225 if (read_batch)
226 write_int(f, NDX_DEL_STATS);
227 else
228 write_ndx(f, NDX_DEL_STATS);
229 write_varint(f, stats.deleted_files - stats.deleted_dirs
230 - stats.deleted_symlinks - stats.deleted_devices
231 - stats.deleted_specials);
232 write_varint(f, stats.deleted_dirs);
233 write_varint(f, stats.deleted_symlinks);
234 write_varint(f, stats.deleted_devices);
235 write_varint(f, stats.deleted_specials);
238 void read_del_stats(int f)
240 stats.deleted_files = read_varint(f);
241 stats.deleted_files += stats.deleted_dirs = read_varint(f);
242 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
243 stats.deleted_files += stats.deleted_devices = read_varint(f);
244 stats.deleted_files += stats.deleted_specials = read_varint(f);
247 static void become_copy_as_user()
249 char *gname;
250 uid_t uid;
251 gid_t gid;
253 if (!copy_as)
254 return;
256 if (DEBUG_GTE(CMD, 2))
257 rprintf(FINFO, "[%s] copy_as=%s\n", who_am_i(), copy_as);
259 if ((gname = strchr(copy_as, ':')) != NULL)
260 *gname++ = '\0';
262 if (!user_to_uid(copy_as, &uid, True)) {
263 rprintf(FERROR, "Invalid copy-as user: %s\n", copy_as);
264 exit_cleanup(RERR_SYNTAX);
267 if (gname) {
268 if (!group_to_gid(gname, &gid, True)) {
269 rprintf(FERROR, "Invalid copy-as group: %s\n", gname);
270 exit_cleanup(RERR_SYNTAX);
272 } else {
273 struct passwd *pw;
274 if ((pw = getpwuid(uid)) == NULL) {
275 rsyserr(FERROR, errno, "getpwuid failed");
276 exit_cleanup(RERR_SYNTAX);
278 gid = pw->pw_gid;
281 if (setgid(gid) < 0) {
282 rsyserr(FERROR, errno, "setgid failed");
283 exit_cleanup(RERR_SYNTAX);
285 #ifdef HAVE_SETGROUPS
286 if (setgroups(1, &gid)) {
287 rsyserr(FERROR, errno, "setgroups failed");
288 exit_cleanup(RERR_SYNTAX);
290 #endif
291 #ifdef HAVE_INITGROUPS
292 if (!gname && initgroups(copy_as, gid) < 0) {
293 rsyserr(FERROR, errno, "initgroups failed");
294 exit_cleanup(RERR_SYNTAX);
296 #endif
298 if (setuid(uid) < 0
299 #ifdef HAVE_SETEUID
300 || seteuid(uid) < 0
301 #endif
303 rsyserr(FERROR, errno, "setuid failed");
304 exit_cleanup(RERR_SYNTAX);
307 our_uid = MY_UID();
308 our_gid = MY_GID();
309 am_root = (our_uid == ROOT_UID);
311 if (gname)
312 gname[-1] = ':';
315 /* This function gets called from all 3 processes. We want the client side
316 * to actually output the text, but the sender is the only process that has
317 * all the stats we need. So, if we're a client sender, we do the report.
318 * If we're a server sender, we write the stats on the supplied fd. If
319 * we're the client receiver we read the stats from the supplied fd and do
320 * the report. All processes might also generate a set of debug stats, if
321 * the verbose level is high enough (this is the only thing that the
322 * generator process and the server receiver ever do here). */
323 static void handle_stats(int f)
325 endtime = time(NULL);
327 /* Cache two stats because the read/write code can change it. */
328 total_read = stats.total_read;
329 total_written = stats.total_written;
331 if (INFO_GTE(STATS, 3)) {
332 /* These come out from every process */
333 show_malloc_stats();
334 show_flist_stats();
337 if (am_generator)
338 return;
340 if (am_daemon) {
341 if (f == -1 || !am_sender)
342 return;
345 if (am_server) {
346 if (am_sender) {
347 write_varlong30(f, total_read, 3);
348 write_varlong30(f, total_written, 3);
349 write_varlong30(f, stats.total_size, 3);
350 if (protocol_version >= 29) {
351 write_varlong30(f, stats.flist_buildtime, 3);
352 write_varlong30(f, stats.flist_xfertime, 3);
355 return;
358 /* this is the client */
360 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
362 else if (!am_sender) {
363 /* Read the first two in opposite order because the meaning of
364 * read/write swaps when switching from sender to receiver. */
365 total_written = read_varlong30(f, 3);
366 total_read = read_varlong30(f, 3);
367 stats.total_size = read_varlong30(f, 3);
368 if (protocol_version >= 29) {
369 stats.flist_buildtime = read_varlong30(f, 3);
370 stats.flist_xfertime = read_varlong30(f, 3);
372 } else if (write_batch) {
373 /* The --read-batch process is going to be a client
374 * receiver, so we need to give it the stats. */
375 write_varlong30(batch_fd, total_read, 3);
376 write_varlong30(batch_fd, total_written, 3);
377 write_varlong30(batch_fd, stats.total_size, 3);
378 if (protocol_version >= 29) {
379 write_varlong30(batch_fd, stats.flist_buildtime, 3);
380 write_varlong30(batch_fd, stats.flist_xfertime, 3);
385 static void output_itemized_counts(const char *prefix, int *counts)
387 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
388 char buf[1024], *pre = " (";
389 int j, len = 0;
390 int total = counts[0];
391 if (total) {
392 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
393 for (j = 0; j < 5; j++) {
394 if (counts[j]) {
395 len += snprintf(buf+len, sizeof buf - len - 2,
396 "%s%s: %s",
397 pre, labels[j], comma_num(counts[j]));
398 pre = ", ";
401 buf[len++] = ')';
403 buf[len] = '\0';
404 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
407 static const char *bytes_per_sec_human_dnum(void)
409 if (starttime == (time_t)-1 || endtime == (time_t)-1)
410 return "UNKNOWN";
411 return human_dnum((total_written + total_read) / (0.5 + (endtime - starttime)), 2);
414 static void output_summary(void)
416 if (INFO_GTE(STATS, 2)) {
417 rprintf(FCLIENT, "\n");
418 output_itemized_counts("Number of files", &stats.num_files);
419 if (protocol_version >= 29)
420 output_itemized_counts("Number of created files", &stats.created_files);
421 if (protocol_version >= 31)
422 output_itemized_counts("Number of deleted files", &stats.deleted_files);
423 rprintf(FINFO,"Number of regular files transferred: %s\n",
424 comma_num(stats.xferred_files));
425 rprintf(FINFO,"Total file size: %s bytes\n",
426 human_num(stats.total_size));
427 rprintf(FINFO,"Total transferred file size: %s bytes\n",
428 human_num(stats.total_transferred_size));
429 rprintf(FINFO,"Literal data: %s bytes\n",
430 human_num(stats.literal_data));
431 rprintf(FINFO,"Matched data: %s bytes\n",
432 human_num(stats.matched_data));
433 rprintf(FINFO,"File list size: %s\n",
434 human_num(stats.flist_size));
435 if (stats.flist_buildtime) {
436 rprintf(FINFO,
437 "File list generation time: %s seconds\n",
438 comma_dnum((double)stats.flist_buildtime / 1000, 3));
439 rprintf(FINFO,
440 "File list transfer time: %s seconds\n",
441 comma_dnum((double)stats.flist_xfertime / 1000, 3));
443 rprintf(FINFO,"Total bytes sent: %s\n",
444 human_num(total_written));
445 rprintf(FINFO,"Total bytes received: %s\n",
446 human_num(total_read));
449 if (INFO_GTE(STATS, 1)) {
450 rprintf(FCLIENT, "\n");
451 rprintf(FINFO,
452 "sent %s bytes received %s bytes %s bytes/sec\n",
453 human_num(total_written), human_num(total_read),
454 bytes_per_sec_human_dnum());
455 rprintf(FINFO, "total size is %s speedup is %s%s\n",
456 human_num(stats.total_size),
457 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
458 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
461 fflush(stdout);
462 fflush(stderr);
467 * If our C library can get malloc statistics, then show them to FINFO
469 static void show_malloc_stats(void)
471 #ifdef MEM_ALLOC_INFO
472 struct MEM_ALLOC_INFO mi = MEM_ALLOC_INFO(); /* mallinfo or mallinfo2 */
474 rprintf(FCLIENT, "\n");
475 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
476 (int)getpid(), am_server ? "server " : "",
477 am_daemon ? "daemon " : "", who_am_i());
479 #define PRINT_ALLOC_NUM(title, descr, num) \
480 rprintf(FINFO, " %-11s%10" SIZE_T_FMT_MOD "d (" descr ")\n", \
481 title ":", (SIZE_T_FMT_CAST)(num));
483 PRINT_ALLOC_NUM("arena", "bytes from sbrk", mi.arena);
484 PRINT_ALLOC_NUM("ordblks", "chunks not in use", mi.ordblks);
485 PRINT_ALLOC_NUM("smblks", "free fastbin blocks", mi.smblks);
486 PRINT_ALLOC_NUM("hblks", "chunks from mmap", mi.hblks);
487 PRINT_ALLOC_NUM("hblkhd", "bytes from mmap", mi.hblkhd);
488 PRINT_ALLOC_NUM("allmem", "bytes from sbrk + mmap", mi.arena + mi.hblkhd);
489 PRINT_ALLOC_NUM("usmblks", "always 0", mi.usmblks);
490 PRINT_ALLOC_NUM("fsmblks", "bytes in freed fastbin blocks", mi.fsmblks);
491 PRINT_ALLOC_NUM("uordblks", "bytes used", mi.uordblks);
492 PRINT_ALLOC_NUM("fordblks", "bytes free", mi.fordblks);
493 PRINT_ALLOC_NUM("keepcost", "bytes in releasable chunk", mi.keepcost);
495 #undef PRINT_ALLOC_NUM
497 #endif /* MEM_ALLOC_INFO */
501 /* Start the remote shell. cmd may be NULL to use the default. */
502 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
503 int *f_in_p, int *f_out_p)
505 int i, argc = 0;
506 char *args[MAX_ARGS], *need_to_free = NULL;
507 pid_t pid;
508 int dash_l_set = 0;
510 if (!read_batch && !local_server) {
511 char *t, *f, in_quote = '\0';
512 char *rsh_env = getenv(RSYNC_RSH_ENV);
513 if (!cmd)
514 cmd = rsh_env;
515 if (!cmd)
516 cmd = RSYNC_RSH;
517 cmd = need_to_free = strdup(cmd);
519 for (t = f = cmd; *f; f++) {
520 if (*f == ' ')
521 continue;
522 /* Comparison leaves rooms for server_options(). */
523 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
524 goto arg_overflow;
525 args[argc++] = t;
526 while (*f != ' ' || in_quote) {
527 if (!*f) {
528 if (in_quote) {
529 rprintf(FERROR,
530 "Missing trailing-%c in remote-shell command.\n",
531 in_quote);
532 exit_cleanup(RERR_SYNTAX);
534 f--;
535 break;
537 if (*f == '\'' || *f == '"') {
538 if (!in_quote) {
539 in_quote = *f++;
540 continue;
542 if (*f == in_quote && *++f != in_quote) {
543 in_quote = '\0';
544 continue;
547 *t++ = *f++;
549 *t++ = '\0';
552 /* NOTE: must preserve t == start of command name until the end of the args handling! */
553 if ((t = strrchr(cmd, '/')) != NULL)
554 t++;
555 else
556 t = cmd;
558 /* Check to see if we've already been given '-l user' in the remote-shell command. */
559 for (i = 0; i < argc-1; i++) {
560 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
561 dash_l_set = 1;
564 #ifdef HAVE_REMSH
565 /* remsh (on HPUX) takes the arguments the other way around */
566 args[argc++] = machine;
567 if (user && !(daemon_connection && dash_l_set)) {
568 args[argc++] = "-l";
569 args[argc++] = user;
571 #else
572 if (user && !(daemon_connection && dash_l_set)) {
573 args[argc++] = "-l";
574 args[argc++] = user;
576 #ifdef AF_INET
577 if (default_af_hint == AF_INET && strcmp(t, "ssh") == 0)
578 args[argc++] = "-4"; /* we're using ssh so we can add a -4 option */
579 #endif
580 #ifdef AF_INET6
581 if (default_af_hint == AF_INET6 && strcmp(t, "ssh") == 0)
582 args[argc++] = "-6"; /* we're using ssh so we can add a -6 option */
583 #endif
584 args[argc++] = machine;
585 #endif
587 args[argc++] = rsync_path;
589 if (blocking_io < 0 && (strcmp(t, "rsh") == 0 || strcmp(t, "remsh") == 0))
590 blocking_io = 1;
592 if (daemon_connection > 0) {
593 args[argc++] = "--server";
594 args[argc++] = "--daemon";
595 } else
596 server_options(args, &argc);
598 if (argc >= MAX_ARGS - 2)
599 goto arg_overflow;
602 args[argc++] = ".";
604 if (!daemon_connection) {
605 while (remote_argc > 0) {
606 if (argc >= MAX_ARGS - 1) {
607 arg_overflow:
608 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
609 exit_cleanup(RERR_SYNTAX);
611 args[argc++] = safe_arg(NULL, *remote_argv++);
612 remote_argc--;
616 args[argc] = NULL;
618 if (DEBUG_GTE(CMD, 2)) {
619 for (i = 0; i < argc; i++)
620 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
621 rprintf(FCLIENT, "\n");
624 if (read_batch) {
625 int from_gen_pipe[2];
626 set_allow_inc_recurse();
627 if (fd_pair(from_gen_pipe) < 0) {
628 rsyserr(FERROR, errno, "pipe");
629 exit_cleanup(RERR_IPC);
631 batch_gen_fd = from_gen_pipe[0];
632 *f_out_p = from_gen_pipe[1];
633 *f_in_p = batch_fd;
634 pid = (pid_t)-1; /* no child pid */
635 #ifdef ICONV_CONST
636 setup_iconv();
637 #endif
638 } else if (local_server) {
639 /* If the user didn't request --[no-]whole-file, force
640 * it on, but only if we're not batch processing. */
641 if (whole_file < 0 && !write_batch)
642 whole_file = 1;
643 set_allow_inc_recurse();
644 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
645 #ifdef ICONV_CONST
646 setup_iconv();
647 #endif
648 } else {
649 pid = piped_child(args, f_in_p, f_out_p);
650 #ifdef ICONV_CONST
651 setup_iconv();
652 #endif
653 if (protect_args && !daemon_connection)
654 send_protected_args(*f_out_p, args);
657 if (need_to_free)
658 free(need_to_free);
660 return pid;
663 /* The receiving side operates in one of two modes:
665 * 1. it receives any number of files into a destination directory,
666 * placing them according to their names in the file-list.
668 * 2. it receives a single file and saves it using the name in the
669 * destination path instead of its file-list name. This requires a
670 * "local name" for writing out the destination file.
672 * So, our task is to figure out what mode/local-name we need.
673 * For mode 1, we change into the destination directory and return NULL.
674 * For mode 2, we change into the directory containing the destination
675 * file (if we aren't already there) and return the local-name. */
676 static char *get_local_name(struct file_list *flist, char *dest_path)
678 STRUCT_STAT st;
679 int statret, trailing_slash;
680 char *cp;
682 if (DEBUG_GTE(RECV, 1)) {
683 rprintf(FINFO, "get_local_name count=%d %s\n",
684 file_total, NS(dest_path));
687 if (!dest_path || list_only)
688 return NULL;
690 /* Treat an empty string as a copy into the current directory. */
691 if (!*dest_path)
692 dest_path = ".";
694 if (daemon_filter_list.head) {
695 char *slash = strrchr(dest_path, '/');
696 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
697 *slash = '\0';
698 else
699 slash = NULL;
700 if ((*dest_path != '.' || dest_path[1] != '\0')
701 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
702 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
703 rprintf(FERROR, "ERROR: daemon has excluded destination \"%s\"\n",
704 dest_path);
705 exit_cleanup(RERR_FILESELECT);
707 if (slash)
708 *slash = '/';
711 /* See what currently exists at the destination. */
712 statret = do_stat(dest_path, &st);
713 cp = strrchr(dest_path, '/');
714 trailing_slash = cp && !cp[1];
716 if (mkpath_dest_arg && statret < 0 && (cp || file_total > 1)) {
717 int save_errno = errno;
718 int ret = make_path(dest_path, file_total > 1 && !trailing_slash ? 0 : MKP_DROP_NAME);
719 if (ret < 0)
720 goto mkdir_error;
721 if (ret && (INFO_GTE(NAME, 1) || stdout_format_has_i)) {
722 if (file_total == 1 || trailing_slash)
723 *cp = '\0';
724 rprintf(FINFO, "created %d director%s for %s\n", ret, ret == 1 ? "y" : "ies", dest_path);
725 if (file_total == 1 || trailing_slash)
726 *cp = '/';
728 if (ret)
729 statret = do_stat(dest_path, &st);
730 else
731 errno = save_errno;
734 if (statret == 0) {
735 /* If the destination is a dir, enter it and use mode 1. */
736 if (S_ISDIR(st.st_mode)) {
737 if (!change_dir(dest_path, CD_NORMAL)) {
738 rsyserr(FERROR, errno, "change_dir#1 %s failed",
739 full_fname(dest_path));
740 exit_cleanup(RERR_FILESELECT);
742 filesystem_dev = st.st_dev; /* ensures --force works right w/-x */
743 return NULL;
745 if (file_total > 1) {
746 rprintf(FERROR,
747 "ERROR: destination must be a directory when"
748 " copying more than 1 file\n");
749 exit_cleanup(RERR_FILESELECT);
751 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
752 rprintf(FERROR,
753 "ERROR: cannot overwrite non-directory"
754 " with a directory\n");
755 exit_cleanup(RERR_FILESELECT);
757 } else if (errno != ENOENT) {
758 /* If we don't know what's at the destination, fail. */
759 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
760 full_fname(dest_path));
761 exit_cleanup(RERR_FILESELECT);
764 /* If we need a destination directory because the transfer is not
765 * of a single non-directory or the user has requested one via a
766 * destination path ending in a slash, create one and use mode 1. */
767 if (file_total > 1 || trailing_slash) {
768 if (trailing_slash)
769 *cp = '\0'; /* Lop off the final slash (if any). */
771 if (statret == 0) {
772 rprintf(FERROR, "ERROR: destination path is not a directory\n");
773 exit_cleanup(RERR_SYNTAX);
776 if (do_mkdir(dest_path, ACCESSPERMS) != 0) {
777 mkdir_error:
778 rsyserr(FERROR, errno, "mkdir %s failed",
779 full_fname(dest_path));
780 exit_cleanup(RERR_FILEIO);
783 if (flist->high >= flist->low
784 && strcmp(flist->files[flist->low]->basename, ".") == 0)
785 flist->files[0]->flags |= FLAG_DIR_CREATED;
787 if (INFO_GTE(NAME, 1) || stdout_format_has_i)
788 rprintf(FINFO, "created directory %s\n", dest_path);
790 if (dry_run) {
791 /* Indicate that dest dir doesn't really exist. */
792 dry_run++;
795 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
796 rsyserr(FERROR, errno, "change_dir#2 %s failed",
797 full_fname(dest_path));
798 exit_cleanup(RERR_FILESELECT);
801 return NULL;
804 /* Otherwise, we are writing a single file, possibly on top of an
805 * existing non-directory. Change to the item's parent directory
806 * (if it has a path component), return the basename of the
807 * destination file as the local name, and use mode 2. */
808 if (!cp)
809 return dest_path;
811 if (cp == dest_path)
812 dest_path = "/";
814 *cp = '\0';
815 if (!change_dir(dest_path, CD_NORMAL)) {
816 rsyserr(FERROR, errno, "change_dir#3 %s failed",
817 full_fname(dest_path));
818 exit_cleanup(RERR_FILESELECT);
820 *cp = '/';
822 return cp + 1;
825 /* This function checks on our alternate-basis directories. If we're in
826 * dry-run mode and the destination dir does not yet exist, we'll try to
827 * tweak any dest-relative paths to make them work for a dry-run (the
828 * destination dir must be in curr_dir[] when this function is called).
829 * We also warn about any arg that is non-existent or not a directory. */
830 static void check_alt_basis_dirs(void)
832 STRUCT_STAT st;
833 char *slash = strrchr(curr_dir, '/');
834 int j;
836 for (j = 0; j < basis_dir_cnt; j++) {
837 char *bdir = basis_dir[j];
838 int bd_len = strlen(bdir);
839 if (bd_len > 1 && bdir[bd_len-1] == '/')
840 bdir[--bd_len] = '\0';
841 if (dry_run > 1 && *bdir != '/') {
842 int len = curr_dir_len + 1 + bd_len + 1;
843 char *new = new_array(char, len);
844 if (slash && strncmp(bdir, "../", 3) == 0) {
845 /* We want to remove only one leading "../" prefix for
846 * the directory we couldn't create in dry-run mode:
847 * this ensures that any other ".." references get
848 * evaluated the same as they would for a live copy. */
849 *slash = '\0';
850 pathjoin(new, len, curr_dir, bdir + 3);
851 *slash = '/';
852 } else
853 pathjoin(new, len, curr_dir, bdir);
854 basis_dir[j] = bdir = new;
856 if (do_stat(bdir, &st) < 0)
857 rprintf(FWARNING, "%s arg does not exist: %s\n", alt_dest_opt(0), bdir);
858 else if (!S_ISDIR(st.st_mode))
859 rprintf(FWARNING, "%s arg is not a dir: %s\n", alt_dest_opt(0), bdir);
863 /* This is only called by the sender. */
864 static void read_final_goodbye(int f_in, int f_out)
866 int i, iflags, xlen;
867 uchar fnamecmp_type;
868 char xname[MAXPATHLEN];
870 shutting_down = True;
872 if (protocol_version < 29)
873 i = read_int(f_in);
874 else {
875 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
876 if (protocol_version >= 31 && i == NDX_DONE) {
877 if (am_sender)
878 write_ndx(f_out, NDX_DONE);
879 else {
880 if (batch_gen_fd >= 0) {
881 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
882 read_del_stats(batch_gen_fd);
884 write_int(f_out, NDX_DONE);
886 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
890 if (i != NDX_DONE) {
891 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
892 i, who_am_i());
893 exit_cleanup(RERR_PROTOCOL);
897 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
899 struct file_list *flist;
900 char *dir;
902 if (DEBUG_GTE(SEND, 1))
903 rprintf(FINFO, "server_sender starting pid=%d\n", (int)getpid());
905 if (am_daemon && lp_write_only(module_id)) {
906 rprintf(FERROR, "ERROR: module is write only\n");
907 exit_cleanup(RERR_SYNTAX);
909 if (am_daemon && read_only && remove_source_files) {
910 rprintf(FERROR,
911 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
912 remove_source_files == 1 ? "source" : "sent");
913 exit_cleanup(RERR_SYNTAX);
915 if (argc < 1) {
916 rprintf(FERROR, "ERROR: do_server_sender called without args\n");
917 exit_cleanup(RERR_SYNTAX);
920 become_copy_as_user();
922 dir = argv[0];
923 if (!relative_paths) {
924 if (!change_dir(dir, CD_NORMAL)) {
925 rsyserr(FERROR, errno, "change_dir#3 %s failed",
926 full_fname(dir));
927 exit_cleanup(RERR_FILESELECT);
930 argc--;
931 argv++;
933 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
934 argc = 1;
935 argv--;
936 argv[0] = ".";
939 flist = send_file_list(f_out,argc,argv);
940 if (!flist || flist->used == 0) {
941 /* Make sure input buffering is off so we can't hang in noop_io_until_death(). */
942 io_end_buffering_in(0);
943 /* TODO: we should really exit in a more controlled manner. */
944 exit_cleanup(0);
947 io_start_buffering_in(f_in);
949 send_files(f_in, f_out);
950 io_flush(FULL_FLUSH);
951 handle_stats(f_out);
952 if (protocol_version >= 24)
953 read_final_goodbye(f_in, f_out);
954 io_flush(FULL_FLUSH);
955 exit_cleanup(0);
959 static int do_recv(int f_in, int f_out, char *local_name)
961 int pid;
962 int exit_code = 0;
963 int error_pipe[2];
965 /* The receiving side mustn't obey this, or an existing symlink that
966 * points to an identical file won't be replaced by the referent. */
967 copy_links = copy_dirlinks = copy_unsafe_links = 0;
969 #ifdef SUPPORT_HARD_LINKS
970 if (preserve_hard_links && !inc_recurse)
971 match_hard_links(first_flist);
972 #endif
974 if (fd_pair(error_pipe) < 0) {
975 rsyserr(FERROR, errno, "pipe failed in do_recv");
976 exit_cleanup(RERR_IPC);
979 if (backup_dir) {
980 STRUCT_STAT st;
981 int ret;
982 if (backup_dir_len > 1)
983 backup_dir_buf[backup_dir_len-1] = '\0';
984 ret = do_stat(backup_dir_buf, &st);
985 if (ret != 0 || !S_ISDIR(st.st_mode)) {
986 if (ret == 0) {
987 rprintf(FERROR, "The backup-dir is not a directory: %s\n", backup_dir_buf);
988 exit_cleanup(RERR_SYNTAX);
990 if (errno != ENOENT) {
991 rprintf(FERROR, "Failed to stat %s: %s\n", backup_dir_buf, strerror(errno));
992 exit_cleanup(RERR_FILEIO);
994 if (INFO_GTE(BACKUP, 1))
995 rprintf(FINFO, "(new) backup_dir is %s\n", backup_dir_buf);
996 } else if (INFO_GTE(BACKUP, 1))
997 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
998 if (backup_dir_len > 1)
999 backup_dir_buf[backup_dir_len-1] = '/';
1002 if (tmpdir) {
1003 STRUCT_STAT st;
1004 int ret = do_stat(tmpdir, &st);
1005 if (ret < 0 || !S_ISDIR(st.st_mode)) {
1006 if (ret == 0) {
1007 rprintf(FERROR, "The temp-dir is not a directory: %s\n", tmpdir);
1008 exit_cleanup(RERR_SYNTAX);
1010 if (errno == ENOENT) {
1011 rprintf(FERROR, "The temp-dir does not exist: %s\n", tmpdir);
1012 exit_cleanup(RERR_SYNTAX);
1014 rprintf(FERROR, "Failed to stat temp-dir %s: %s\n", tmpdir, strerror(errno));
1015 exit_cleanup(RERR_FILEIO);
1019 io_flush(FULL_FLUSH);
1021 if ((pid = do_fork()) == -1) {
1022 rsyserr(FERROR, errno, "fork failed in do_recv");
1023 exit_cleanup(RERR_IPC);
1026 if (pid == 0) {
1027 am_receiver = 1;
1028 send_msgs_to_gen = am_server;
1030 close(error_pipe[0]);
1032 /* We can't let two processes write to the socket at one time. */
1033 io_end_multiplex_out(MPLX_SWITCHING);
1034 if (f_in != f_out)
1035 close(f_out);
1036 sock_f_out = -1;
1037 f_out = error_pipe[1];
1039 bwlimit_writemax = 0; /* receiver doesn't need to do this */
1041 if (read_batch)
1042 io_start_buffering_in(f_in);
1043 io_start_multiplex_out(f_out);
1045 recv_files(f_in, f_out, local_name);
1046 io_flush(FULL_FLUSH);
1047 handle_stats(f_in);
1049 if (output_needs_newline) {
1050 fputc('\n', stdout);
1051 output_needs_newline = 0;
1054 write_int(f_out, NDX_DONE);
1055 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
1056 io_flush(FULL_FLUSH);
1058 /* Handle any keep-alive packets from the post-processing work
1059 * that the generator does. */
1060 if (protocol_version >= 29) {
1061 kluge_around_eof = -1;
1063 /* This should only get stopped via a USR2 signal. */
1064 read_final_goodbye(f_in, f_out);
1066 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
1067 who_am_i());
1068 exit_cleanup(RERR_PROTOCOL);
1071 /* Finally, we go to sleep until our parent kills us with a
1072 * USR2 signal. We sleep for a short time, as on some OSes
1073 * a signal won't interrupt a sleep! */
1074 while (1)
1075 msleep(20);
1078 am_generator = 1;
1079 flist_receiving_enabled = True;
1081 io_end_multiplex_in(MPLX_SWITCHING);
1082 if (write_batch && !am_server)
1083 stop_write_batch();
1085 close(error_pipe[1]);
1086 if (f_in != f_out)
1087 close(f_in);
1088 sock_f_in = -1;
1089 f_in = error_pipe[0];
1091 io_start_buffering_out(f_out);
1092 io_start_multiplex_in(f_in);
1094 #ifdef SUPPORT_HARD_LINKS
1095 if (preserve_hard_links && inc_recurse) {
1096 struct file_list *flist;
1097 for (flist = first_flist; flist; flist = flist->next)
1098 match_hard_links(flist);
1100 #endif
1102 generate_files(f_out, local_name);
1104 handle_stats(-1);
1105 io_flush(FULL_FLUSH);
1106 shutting_down = True;
1107 if (protocol_version >= 24) {
1108 /* send a final goodbye message */
1109 write_ndx(f_out, NDX_DONE);
1111 io_flush(FULL_FLUSH);
1113 kill(pid, SIGUSR2);
1114 wait_process_with_flush(pid, &exit_code);
1115 return exit_code;
1118 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
1120 int exit_code;
1121 struct file_list *flist;
1122 char *local_name = NULL;
1123 int negated_levels;
1125 if (filesfrom_fd >= 0 && msgs2stderr != 1 && protocol_version < 31) {
1126 /* We can't mix messages with files-from data on the socket,
1127 * so temporarily turn off info/debug messages. */
1128 negate_output_levels();
1129 negated_levels = 1;
1130 } else
1131 negated_levels = 0;
1133 if (DEBUG_GTE(RECV, 1))
1134 rprintf(FINFO, "server_recv(%d) starting pid=%d\n", argc, (int)getpid());
1136 if (am_daemon && read_only) {
1137 rprintf(FERROR,"ERROR: module is read only\n");
1138 exit_cleanup(RERR_SYNTAX);
1139 return;
1142 become_copy_as_user();
1144 if (argc > 0) {
1145 char *dir = argv[0];
1146 argc--;
1147 argv++;
1148 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
1149 rsyserr(FERROR, errno, "change_dir#4 %s failed",
1150 full_fname(dir));
1151 exit_cleanup(RERR_FILESELECT);
1155 if (protocol_version >= 30)
1156 io_start_multiplex_in(f_in);
1157 else
1158 io_start_buffering_in(f_in);
1159 recv_filter_list(f_in);
1161 if (filesfrom_fd >= 0) {
1162 /* We need to send the files-from names to the sender at the
1163 * same time that we receive the file-list from them, so we
1164 * need the IO routines to automatically write out the names
1165 * onto our f_out socket as we read the file-list. This
1166 * avoids both deadlock and extra delays/buffers. */
1167 start_filesfrom_forwarding(filesfrom_fd);
1168 filesfrom_fd = -1;
1171 flist = recv_file_list(f_in, -1);
1172 if (!flist) {
1173 rprintf(FERROR,"server_recv: recv_file_list error\n");
1174 exit_cleanup(RERR_FILESELECT);
1176 if (inc_recurse && file_total == 1)
1177 recv_additional_file_list(f_in);
1179 if (negated_levels)
1180 negate_output_levels();
1182 if (argc > 0)
1183 local_name = get_local_name(flist,argv[0]);
1185 /* Now that we know what our destination directory turned out to be,
1186 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1187 if (sanitize_paths) {
1188 char **dir_p;
1189 for (dir_p = basis_dir; *dir_p; dir_p++)
1190 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1191 if (partial_dir)
1192 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1194 check_alt_basis_dirs();
1196 if (daemon_filter_list.head) {
1197 char **dir_p;
1198 filter_rule_list *elp = &daemon_filter_list;
1200 for (dir_p = basis_dir; *dir_p; dir_p++) {
1201 char *dir = *dir_p;
1202 if (*dir == '/')
1203 dir += module_dirlen;
1204 if (check_filter(elp, FLOG, dir, 1) < 0)
1205 goto options_rejected;
1207 if (partial_dir && *partial_dir == '/'
1208 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1209 options_rejected:
1210 rprintf(FERROR, "Your options have been rejected by the server.\n");
1211 exit_cleanup(RERR_SYNTAX);
1215 exit_code = do_recv(f_in, f_out, local_name);
1216 exit_cleanup(exit_code);
1220 int child_main(int argc, char *argv[])
1222 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1223 return 0;
1227 void start_server(int f_in, int f_out, int argc, char *argv[])
1229 set_nonblocking(f_in);
1230 set_nonblocking(f_out);
1232 io_set_sock_fds(f_in, f_out);
1233 setup_protocol(f_out, f_in);
1235 if (protocol_version >= 23)
1236 io_start_multiplex_out(f_out);
1237 if (am_daemon && io_timeout && protocol_version >= 31)
1238 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1240 if (am_sender) {
1241 keep_dirlinks = 0; /* Must be disabled on the sender. */
1242 if (need_messages_from_generator)
1243 io_start_multiplex_in(f_in);
1244 else
1245 io_start_buffering_in(f_in);
1246 recv_filter_list(f_in);
1247 do_server_sender(f_in, f_out, argc, argv);
1248 } else
1249 do_server_recv(f_in, f_out, argc, argv);
1250 exit_cleanup(0);
1253 /* This is called once the connection has been negotiated. It is used
1254 * for rsyncd, remote-shell, and local connections. */
1255 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1257 struct file_list *flist = NULL;
1258 int exit_code = 0, exit_code2 = 0;
1259 char *local_name = NULL;
1261 cleanup_child_pid = pid;
1262 if (!read_batch) {
1263 set_nonblocking(f_in);
1264 set_nonblocking(f_out);
1267 io_set_sock_fds(f_in, f_out);
1268 setup_protocol(f_out,f_in);
1270 /* We set our stderr file handle to blocking because ssh might have
1271 * set it to non-blocking. This can be particularly troublesome if
1272 * stderr is a clone of stdout, because ssh would have set our stdout
1273 * to non-blocking at the same time (which can easily cause us to lose
1274 * output from our print statements). This kluge shouldn't cause ssh
1275 * any problems for how we use it. Note also that we delayed setting
1276 * this until after the above protocol setup so that we know for sure
1277 * that ssh is done twiddling its file descriptors. */
1278 set_blocking(STDERR_FILENO);
1280 if (am_sender) {
1281 keep_dirlinks = 0; /* Must be disabled on the sender. */
1283 if (always_checksum
1284 && (log_format_has(stdout_format, 'C')
1285 || log_format_has(logfile_format, 'C')))
1286 sender_keeps_checksum = 1;
1288 if (protocol_version >= 30)
1289 io_start_multiplex_out(f_out);
1290 else
1291 io_start_buffering_out(f_out);
1292 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1293 io_start_multiplex_in(f_in);
1294 else
1295 io_start_buffering_in(f_in);
1296 send_filter_list(f_out);
1297 if (filesfrom_host)
1298 filesfrom_fd = f_in;
1300 if (write_batch && !am_server)
1301 start_write_batch(f_out);
1303 become_copy_as_user();
1305 flist = send_file_list(f_out, argc, argv);
1306 if (DEBUG_GTE(FLIST, 3))
1307 rprintf(FINFO,"file list sent\n");
1309 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1310 io_start_multiplex_in(f_in);
1312 io_flush(NORMAL_FLUSH);
1313 send_files(f_in, f_out);
1314 io_flush(FULL_FLUSH);
1315 handle_stats(-1);
1316 if (protocol_version >= 24)
1317 read_final_goodbye(f_in, f_out);
1318 if (pid != -1) {
1319 if (DEBUG_GTE(EXIT, 2))
1320 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1321 io_flush(FULL_FLUSH);
1322 wait_process_with_flush(pid, &exit_code);
1324 output_summary();
1325 io_flush(FULL_FLUSH);
1326 exit_cleanup(exit_code);
1329 if (!read_batch) {
1330 if (protocol_version >= 23)
1331 io_start_multiplex_in(f_in);
1332 if (need_messages_from_generator)
1333 io_start_multiplex_out(f_out);
1334 else
1335 io_start_buffering_out(f_out);
1338 become_copy_as_user();
1340 send_filter_list(read_batch ? -1 : f_out);
1342 if (filesfrom_fd >= 0) {
1343 start_filesfrom_forwarding(filesfrom_fd);
1344 filesfrom_fd = -1;
1347 if (write_batch && !am_server)
1348 start_write_batch(f_in);
1349 flist = recv_file_list(f_in, -1);
1350 if (inc_recurse && file_total == 1)
1351 recv_additional_file_list(f_in);
1353 if (flist && flist->used > 0) {
1354 local_name = get_local_name(flist, argv[0]);
1356 check_alt_basis_dirs();
1358 exit_code2 = do_recv(f_in, f_out, local_name);
1359 } else {
1360 handle_stats(-1);
1361 output_summary();
1364 if (pid != -1) {
1365 if (DEBUG_GTE(RECV, 1))
1366 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1367 io_flush(FULL_FLUSH);
1368 wait_process_with_flush(pid, &exit_code);
1371 return MAX(exit_code, exit_code2);
1374 static void dup_argv(char *argv[])
1376 int i;
1378 for (i = 0; argv[i]; i++)
1379 argv[i] = strdup(argv[i]);
1383 /* Start a client for either type of remote connection. Work out
1384 * whether the arguments request a remote shell or rsyncd connection,
1385 * and call the appropriate connection function, then run_client.
1387 * Calls either start_socket_client (for sockets) or do_cmd and
1388 * client_run (for ssh). */
1389 static int start_client(int argc, char *argv[])
1391 char *p, *shell_machine = NULL, *shell_user = NULL;
1392 char **remote_argv;
1393 int remote_argc, env_port = rsync_port;
1394 int f_in, f_out;
1395 int ret;
1396 pid_t pid;
1398 /* Don't clobber argv[] so that ps(1) can still show the right
1399 * command line. */
1400 dup_argv(argv);
1402 if (!read_batch) { /* for read_batch, NO source is specified */
1403 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1404 if (path) { /* source is remote */
1405 char *dummy_host;
1406 int dummy_port = 0;
1407 *argv = path;
1408 remote_argv = argv;
1409 remote_argc = argc;
1410 argv += argc - 1;
1411 if (argc == 1 || **argv == ':')
1412 argc = 0; /* no dest arg */
1413 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1414 rprintf(FERROR,
1415 "The source and destination cannot both be remote.\n");
1416 exit_cleanup(RERR_SYNTAX);
1417 } else {
1418 remote_argc--; /* don't count dest */
1419 argc = 1;
1421 if (filesfrom_host && *filesfrom_host && strcmp(filesfrom_host, shell_machine) != 0) {
1422 rprintf(FERROR,
1423 "--files-from hostname is not the same as the transfer hostname\n");
1424 exit_cleanup(RERR_SYNTAX);
1426 am_sender = 0;
1427 if (rsync_port)
1428 daemon_connection = shell_cmd ? 1 : -1;
1429 } else { /* source is local, check dest arg */
1430 am_sender = 1;
1432 if (argc > 1) {
1433 p = argv[--argc];
1434 remote_argv = argv + argc;
1435 } else {
1436 static char *dotarg[1] = { "." };
1437 p = dotarg[0];
1438 remote_argv = dotarg;
1440 remote_argc = 1;
1442 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1443 if (path && filesfrom_host && *filesfrom_host && strcmp(filesfrom_host, shell_machine) != 0) {
1444 rprintf(FERROR,
1445 "--files-from hostname is not the same as the transfer hostname\n");
1446 exit_cleanup(RERR_SYNTAX);
1448 if (!path) { /* no hostspec found, so src & dest are local */
1449 local_server = 1;
1450 if (filesfrom_host) {
1451 rprintf(FERROR,
1452 "--files-from cannot be remote when the transfer is local\n");
1453 exit_cleanup(RERR_SYNTAX);
1455 shell_machine = NULL;
1456 rsync_port = 0;
1457 } else { /* hostspec was found, so dest is remote */
1458 argv[argc] = path;
1459 if (rsync_port)
1460 daemon_connection = shell_cmd ? 1 : -1;
1463 } else { /* read_batch */
1464 local_server = 1;
1465 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1466 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1467 exit_cleanup(RERR_SYNTAX);
1469 remote_argv = argv += argc - 1;
1470 remote_argc = argc = 1;
1471 rsync_port = 0;
1474 /* A local transfer doesn't unbackslash anything, so leave the args alone. */
1475 if (local_server)
1476 old_style_args = 2;
1478 if (!rsync_port && remote_argc && !**remote_argv) /* Turn an empty arg into a dot dir. */
1479 *remote_argv = ".";
1481 if (am_sender) {
1482 char *dummy_host;
1483 int dummy_port = rsync_port;
1484 int i;
1485 if (!argv[0][0])
1486 goto invalid_empty;
1487 /* For local source, extra source args must not have hostspec. */
1488 for (i = 1; i < argc; i++) {
1489 if (!argv[i][0]) {
1490 invalid_empty:
1491 rprintf(FERROR, "Empty source arg specified.\n");
1492 exit_cleanup(RERR_SYNTAX);
1494 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1495 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1496 exit_cleanup(RERR_SYNTAX);
1499 } else {
1500 char *dummy_host;
1501 int dummy_port = rsync_port;
1502 int i;
1503 /* For remote source, any extra source args must have either
1504 * the same hostname or an empty hostname. */
1505 for (i = 1; i < remote_argc; i++) {
1506 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1507 if (!arg) {
1508 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1509 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1510 exit_cleanup(RERR_SYNTAX);
1512 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1513 rprintf(FERROR, "All source args must come from the same machine.\n");
1514 exit_cleanup(RERR_SYNTAX);
1516 if (rsync_port != dummy_port) {
1517 if (!rsync_port || !dummy_port)
1518 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1519 else
1520 rprintf(FERROR, "All source args must use the same port number.\n");
1521 exit_cleanup(RERR_SYNTAX);
1523 if (!rsync_port && !*arg) /* Turn an empty arg into a dot dir. */
1524 arg = ".";
1525 remote_argv[i] = arg;
1529 if (rsync_port < 0)
1530 rsync_port = RSYNC_PORT;
1531 else
1532 env_port = rsync_port;
1534 if (daemon_connection < 0)
1535 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1537 if (password_file && !daemon_connection) {
1538 rprintf(FERROR, "The --password-file option may only be "
1539 "used when accessing an rsync daemon.\n");
1540 exit_cleanup(RERR_SYNTAX);
1543 if (connect_timeout) {
1544 rprintf(FERROR, "The --contimeout option may only be "
1545 "used when connecting to an rsync daemon.\n");
1546 exit_cleanup(RERR_SYNTAX);
1549 if (shell_machine) {
1550 p = strrchr(shell_machine,'@');
1551 if (p) {
1552 *p = 0;
1553 shell_user = shell_machine;
1554 shell_machine = p+1;
1558 if (DEBUG_GTE(CMD, 2)) {
1559 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1560 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1561 NS(remote_argv[0]));
1564 #ifdef HAVE_PUTENV
1565 if (daemon_connection)
1566 set_env_num("RSYNC_PORT", env_port);
1567 #else
1568 (void)env_port;
1569 #endif
1571 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc, &f_in, &f_out);
1573 /* if we're running an rsync server on the remote host over a
1574 * remote shell command, we need to do the RSYNCD protocol first */
1575 if (daemon_connection) {
1576 int tmpret;
1577 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1578 if (tmpret < 0)
1579 return tmpret;
1582 ret = client_run(f_in, f_out, pid, argc, argv);
1584 fflush(stdout);
1585 fflush(stderr);
1587 return ret;
1591 static void sigusr1_handler(UNUSED(int val))
1593 called_from_signal_handler = 1;
1594 exit_cleanup(RERR_SIGNAL1);
1597 static void sigusr2_handler(UNUSED(int val))
1599 if (!am_server)
1600 output_summary();
1601 close_all();
1602 if (got_xfer_error)
1603 _exit(RERR_PARTIAL);
1604 _exit(0);
1607 #if defined SIGINFO || defined SIGVTALRM
1608 static void siginfo_handler(UNUSED(int val))
1610 if (!am_server && !INFO_GTE(PROGRESS, 1))
1611 want_progress_now = True;
1613 #endif
1615 void remember_children(UNUSED(int val))
1617 #ifdef WNOHANG
1618 int cnt, status;
1619 pid_t pid;
1620 /* An empty waitpid() loop was put here by Tridge and we could never
1621 * get him to explain why he put it in, so rather than taking it
1622 * out we're instead saving the child exit statuses for later use.
1623 * The waitpid() loop presumably eliminates all possibility of leaving
1624 * zombie children, maybe that's why he did it. */
1625 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1626 /* save the child's exit status */
1627 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1628 if (pid_stat_table[cnt].pid == 0) {
1629 pid_stat_table[cnt].pid = pid;
1630 pid_stat_table[cnt].status = status;
1631 break;
1635 #endif
1636 #ifndef HAVE_SIGACTION
1637 signal(SIGCHLD, remember_children);
1638 #endif
1642 * This routine catches signals and tries to send them to gdb.
1644 * Because it's called from inside a signal handler it ought not to
1645 * use too many library routines.
1647 * @todo Perhaps use "screen -X" instead/as well, to help people
1648 * debugging without easy access to X. Perhaps use an environment
1649 * variable, or just call a script?
1651 * @todo The /proc/ magic probably only works on Linux (and
1652 * Solaris?) Can we be more portable?
1654 #ifdef MAINTAINER_MODE
1655 const char *get_panic_action(void)
1657 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1659 if (cmd_fmt)
1660 return cmd_fmt;
1661 return "xterm -display :0 -T Panic -n Panic -e gdb /proc/%d/exe %d";
1665 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1667 * This signal handler is only installed if we were configured with
1668 * --enable-maintainer-mode. Perhaps it should always be on and we
1669 * should just look at the environment variable, but I'm a bit leery
1670 * of a signal sending us into a busy loop.
1672 static void rsync_panic_handler(UNUSED(int whatsig))
1674 char cmd_buf[300];
1675 int ret, pid_int = getpid();
1677 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(), pid_int, pid_int);
1679 /* Unless we failed to execute gdb, we allow the process to
1680 * continue. I'm not sure if that's right. */
1681 ret = shell_exec(cmd_buf);
1682 if (ret)
1683 _exit(ret);
1685 #endif
1687 static void unset_env_var(const char *var)
1689 #ifdef HAVE_UNSETENV
1690 unsetenv(var);
1691 #else
1692 #ifdef HAVE_PUTENV
1693 char *mem;
1694 if (asprintf(&mem, "%s=", var) < 0)
1695 out_of_memory("unset_env_var");
1696 putenv(mem);
1697 #else
1698 (void)var;
1699 #endif
1700 #endif
1704 int main(int argc,char *argv[])
1706 int ret;
1708 raw_argc = argc;
1709 raw_argv = argv;
1711 #ifdef HAVE_SIGACTION
1712 # ifdef HAVE_SIGPROCMASK
1713 sigset_t sigmask;
1715 sigemptyset(&sigmask);
1716 # endif
1717 sigact.sa_flags = SA_NOCLDSTOP;
1718 #endif
1719 SIGACTMASK(SIGUSR1, sigusr1_handler);
1720 SIGACTMASK(SIGUSR2, sigusr2_handler);
1721 SIGACTMASK(SIGCHLD, remember_children);
1722 #ifdef MAINTAINER_MODE
1723 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1724 SIGACTMASK(SIGFPE, rsync_panic_handler);
1725 SIGACTMASK(SIGABRT, rsync_panic_handler);
1726 SIGACTMASK(SIGBUS, rsync_panic_handler);
1727 #endif
1728 #ifdef SIGINFO
1729 SIGACTMASK(SIGINFO, siginfo_handler);
1730 #endif
1731 #ifdef SIGVTALRM
1732 SIGACTMASK(SIGVTALRM, siginfo_handler);
1733 #endif
1735 starttime = time(NULL);
1736 our_uid = MY_UID();
1737 our_gid = MY_GID();
1738 am_root = our_uid == ROOT_UID;
1740 unset_env_var("DISPLAY");
1742 memset(&stats, 0, sizeof(stats));
1744 /* Even a non-daemon runs needs the default config values to be set, e.g.
1745 * lp_dont_compress() is queried when no --skip-compress option is set. */
1746 reset_daemon_vars();
1748 if (argc < 2) {
1749 usage(FERROR);
1750 exit_cleanup(RERR_SYNTAX);
1753 /* Get the umask for use in permission calculations. We no longer set
1754 * it to zero; that is ugly and pointless now that all the callers that
1755 * relied on it have been reeducated to work with default ACLs. */
1756 umask(orig_umask = umask(0));
1758 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1759 setlocale(LC_CTYPE, "");
1760 setlocale(LC_NUMERIC, "");
1761 #endif
1763 if (!parse_arguments(&argc, (const char ***) &argv)) {
1764 option_error();
1765 exit_cleanup(RERR_SYNTAX);
1767 if (write_batch
1768 && poptDupArgv(argc, (const char **)argv, &cooked_argc, (const char ***)&cooked_argv) != 0)
1769 out_of_memory("main");
1771 SIGACTMASK(SIGINT, sig_int);
1772 SIGACTMASK(SIGHUP, sig_int);
1773 SIGACTMASK(SIGTERM, sig_int);
1774 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1775 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1776 #endif
1778 /* Ignore SIGPIPE; we consistently check error codes and will
1779 * see the EPIPE. */
1780 SIGACTION(SIGPIPE, SIG_IGN);
1781 #ifdef SIGXFSZ
1782 SIGACTION(SIGXFSZ, SIG_IGN);
1783 #endif
1785 /* Initialize change_dir() here because on some old systems getcwd
1786 * (implemented by forking "pwd" and reading its output) doesn't
1787 * work when there are other child processes. Also, on all systems
1788 * that implement getcwd that way "pwd" can't be found after chroot. */
1789 change_dir(NULL, CD_NORMAL);
1791 if ((write_batch || read_batch) && !am_server) {
1792 open_batch_files(); /* sets batch_fd */
1793 if (read_batch)
1794 read_stream_flags(batch_fd);
1795 else
1796 write_stream_flags(batch_fd);
1798 if (write_batch < 0)
1799 dry_run = 1;
1801 if (am_server) {
1802 #ifdef ICONV_CONST
1803 setup_iconv();
1804 #endif
1805 } else if (am_daemon)
1806 return daemon_main();
1808 if (am_server && protect_args) {
1809 char buf[MAXPATHLEN];
1810 protect_args = 2;
1811 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1812 if (!parse_arguments(&argc, (const char ***) &argv)) {
1813 option_error();
1814 exit_cleanup(RERR_SYNTAX);
1818 if (argc < 1) {
1819 usage(FERROR);
1820 exit_cleanup(RERR_SYNTAX);
1823 if (am_server) {
1824 set_nonblocking(STDIN_FILENO);
1825 set_nonblocking(STDOUT_FILENO);
1826 if (am_daemon)
1827 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1828 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1831 ret = start_client(argc, argv);
1832 if (ret == -1)
1833 exit_cleanup(RERR_STARTCLIENT);
1834 else
1835 exit_cleanup(ret);
1837 return ret;