Fix a bug in the writing of the batch.sh file
[rsync.git] / main.c
blob2e2094d26bcafb8e31a55bc81693168b0bec6b39
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-2020 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 "io.h"
26 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
27 #include <locale.h>
28 #endif
30 extern int dry_run;
31 extern int list_only;
32 extern int io_timeout;
33 extern int am_root;
34 extern int am_server;
35 extern int am_sender;
36 extern int am_daemon;
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 called_from_signal_handler;
43 extern int need_messages_from_generator;
44 extern int kluge_around_eof;
45 extern int got_xfer_error;
46 extern int msgs2stderr;
47 extern int module_id;
48 extern int read_only;
49 extern int copy_links;
50 extern int copy_dirlinks;
51 extern int copy_unsafe_links;
52 extern int keep_dirlinks;
53 extern int preserve_hard_links;
54 extern int protocol_version;
55 extern int file_total;
56 extern int recurse;
57 extern int xfer_dirs;
58 extern int protect_args;
59 extern int relative_paths;
60 extern int sanitize_paths;
61 extern int curr_dir_depth;
62 extern int curr_dir_len;
63 extern int module_id;
64 extern int rsync_port;
65 extern int whole_file;
66 extern int read_batch;
67 extern int write_batch;
68 extern int batch_fd;
69 extern int sock_f_in;
70 extern int sock_f_out;
71 extern int filesfrom_fd;
72 extern int connect_timeout;
73 extern int send_msgs_to_gen;
74 extern dev_t filesystem_dev;
75 extern pid_t cleanup_child_pid;
76 extern size_t bwlimit_writemax;
77 extern unsigned int module_dirlen;
78 extern BOOL flist_receiving_enabled;
79 extern BOOL want_progress_now;
80 extern BOOL shutting_down;
81 extern int backup_dir_len;
82 extern int basis_dir_cnt;
83 extern struct stats stats;
84 extern char *stdout_format;
85 extern char *logfile_format;
86 extern char *filesfrom_host;
87 extern char *partial_dir;
88 extern char *dest_option;
89 extern char *rsync_path;
90 extern char *shell_cmd;
91 extern char *batch_name;
92 extern char *password_file;
93 extern char *backup_dir;
94 extern char *copy_as;
95 extern char curr_dir[MAXPATHLEN];
96 extern char backup_dir_buf[MAXPATHLEN];
97 extern char *basis_dir[MAX_BASIS_DIRS+1];
98 extern struct file_list *first_flist;
99 extern filter_rule_list daemon_filter_list;
101 uid_t our_uid;
102 gid_t our_gid;
103 int am_receiver = 0; /* Only set to 1 after the receiver/generator fork. */
104 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
105 int local_server = 0;
106 int daemon_over_rsh = 0;
107 mode_t orig_umask = 0;
108 int batch_gen_fd = -1;
109 int sender_keeps_checksum = 0;
111 /* There's probably never more than at most 2 outstanding child processes,
112 * but set it higher, just in case. */
113 #define MAXCHILDPROCS 7
115 #ifdef HAVE_SIGACTION
116 # ifdef HAVE_SIGPROCMASK
117 # define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
118 # else
119 # define SIGACTMASK(n,h) SIGACTION(n,h)
120 # endif
121 static struct sigaction sigact;
122 #endif
124 struct pid_status {
125 pid_t pid;
126 int status;
127 } pid_stat_table[MAXCHILDPROCS];
129 static time_t starttime, endtime;
130 static int64 total_read, total_written;
132 static void show_malloc_stats(void);
134 /* Works like waitpid(), but if we already harvested the child pid in our
135 * remember_children(), we succeed instead of returning an error. */
136 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
138 pid_t waited_pid;
140 do {
141 waited_pid = waitpid(pid, status_ptr, flags);
142 } while (waited_pid == -1 && errno == EINTR);
144 if (waited_pid == -1 && errno == ECHILD) {
145 /* Status of requested child no longer available: check to
146 * see if it was processed by remember_children(). */
147 int cnt;
148 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
149 if (pid == pid_stat_table[cnt].pid) {
150 *status_ptr = pid_stat_table[cnt].status;
151 pid_stat_table[cnt].pid = 0;
152 return pid;
157 return waited_pid;
160 int shell_exec(const char *cmd)
162 char *shell = getenv("RSYNC_SHELL");
163 int status;
164 pid_t pid;
166 if (!shell)
167 return system(cmd);
169 if ((pid = fork()) < 0)
170 return -1;
172 if (pid == 0) {
173 execlp(shell, shell, "-c", cmd, NULL);
174 _exit(1);
177 int ret = wait_process(pid, &status, 0);
178 return ret < 0 ? -1 : status;
181 /* Wait for a process to exit, calling io_flush while waiting. */
182 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
184 pid_t waited_pid;
185 int status;
187 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
188 msleep(20);
189 io_flush(FULL_FLUSH);
192 /* TODO: If the child exited on a signal, then log an
193 * appropriate error message. Perhaps we should also accept a
194 * message describing the purpose of the child. Also indicate
195 * this to the caller so that they know something went wrong. */
196 if (waited_pid < 0) {
197 rsyserr(FERROR, errno, "waitpid");
198 *exit_code_ptr = RERR_WAITCHILD;
199 } else if (!WIFEXITED(status)) {
200 #ifdef WCOREDUMP
201 if (WCOREDUMP(status))
202 *exit_code_ptr = RERR_CRASHED;
203 else
204 #endif
205 if (WIFSIGNALED(status))
206 *exit_code_ptr = RERR_TERMINATED;
207 else
208 *exit_code_ptr = RERR_WAITCHILD;
209 } else
210 *exit_code_ptr = WEXITSTATUS(status);
213 void write_del_stats(int f)
215 if (read_batch)
216 write_int(f, NDX_DEL_STATS);
217 else
218 write_ndx(f, NDX_DEL_STATS);
219 write_varint(f, stats.deleted_files - stats.deleted_dirs
220 - stats.deleted_symlinks - stats.deleted_devices
221 - stats.deleted_specials);
222 write_varint(f, stats.deleted_dirs);
223 write_varint(f, stats.deleted_symlinks);
224 write_varint(f, stats.deleted_devices);
225 write_varint(f, stats.deleted_specials);
228 void read_del_stats(int f)
230 stats.deleted_files = read_varint(f);
231 stats.deleted_files += stats.deleted_dirs = read_varint(f);
232 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
233 stats.deleted_files += stats.deleted_devices = read_varint(f);
234 stats.deleted_files += stats.deleted_specials = read_varint(f);
237 static void become_copy_as_user()
239 char *gname;
240 uid_t uid;
241 gid_t gid;
243 if (!copy_as)
244 return;
246 if (DEBUG_GTE(CMD, 2))
247 rprintf(FINFO, "[%s] copy_as=%s\n", who_am_i(), copy_as);
249 if ((gname = strchr(copy_as, ':')) != NULL)
250 *gname++ = '\0';
252 if (!user_to_uid(copy_as, &uid, True)) {
253 rprintf(FERROR, "Invalid copy-as user: %s\n", copy_as);
254 exit_cleanup(RERR_SYNTAX);
257 if (gname) {
258 if (!group_to_gid(gname, &gid, True)) {
259 rprintf(FERROR, "Invalid copy-as group: %s\n", gname);
260 exit_cleanup(RERR_SYNTAX);
262 } else {
263 struct passwd *pw;
264 if ((pw = getpwuid(uid)) == NULL) {
265 rsyserr(FERROR, errno, "getpwuid failed");
266 exit_cleanup(RERR_SYNTAX);
268 gid = pw->pw_gid;
271 if (setgid(gid) < 0) {
272 rsyserr(FERROR, errno, "setgid failed");
273 exit_cleanup(RERR_SYNTAX);
275 #ifdef HAVE_SETGROUPS
276 if (setgroups(1, &gid)) {
277 rsyserr(FERROR, errno, "setgroups failed");
278 exit_cleanup(RERR_SYNTAX);
280 #endif
281 #ifdef HAVE_INITGROUPS
282 if (!gname && initgroups(copy_as, gid) < 0) {
283 rsyserr(FERROR, errno, "initgroups failed");
284 exit_cleanup(RERR_SYNTAX);
286 #endif
288 if (setuid(uid) < 0
289 #ifdef HAVE_SETEUID
290 || seteuid(uid) < 0
291 #endif
293 rsyserr(FERROR, errno, "setuid failed");
294 exit_cleanup(RERR_SYNTAX);
297 our_uid = MY_UID();
298 our_gid = MY_GID();
299 am_root = (our_uid == 0);
301 if (gname)
302 gname[-1] = ':';
305 /* This function gets called from all 3 processes. We want the client side
306 * to actually output the text, but the sender is the only process that has
307 * all the stats we need. So, if we're a client sender, we do the report.
308 * If we're a server sender, we write the stats on the supplied fd. If
309 * we're the client receiver we read the stats from the supplied fd and do
310 * the report. All processes might also generate a set of debug stats, if
311 * the verbose level is high enough (this is the only thing that the
312 * generator process and the server receiver ever do here). */
313 static void handle_stats(int f)
315 endtime = time(NULL);
317 /* Cache two stats because the read/write code can change it. */
318 total_read = stats.total_read;
319 total_written = stats.total_written;
321 if (INFO_GTE(STATS, 3)) {
322 /* These come out from every process */
323 show_malloc_stats();
324 show_flist_stats();
327 if (am_generator)
328 return;
330 if (am_daemon) {
331 if (f == -1 || !am_sender)
332 return;
335 if (am_server) {
336 if (am_sender) {
337 write_varlong30(f, total_read, 3);
338 write_varlong30(f, total_written, 3);
339 write_varlong30(f, stats.total_size, 3);
340 if (protocol_version >= 29) {
341 write_varlong30(f, stats.flist_buildtime, 3);
342 write_varlong30(f, stats.flist_xfertime, 3);
345 return;
348 /* this is the client */
350 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
352 else if (!am_sender) {
353 /* Read the first two in opposite order because the meaning of
354 * read/write swaps when switching from sender to receiver. */
355 total_written = read_varlong30(f, 3);
356 total_read = read_varlong30(f, 3);
357 stats.total_size = read_varlong30(f, 3);
358 if (protocol_version >= 29) {
359 stats.flist_buildtime = read_varlong30(f, 3);
360 stats.flist_xfertime = read_varlong30(f, 3);
362 } else if (write_batch) {
363 /* The --read-batch process is going to be a client
364 * receiver, so we need to give it the stats. */
365 write_varlong30(batch_fd, total_read, 3);
366 write_varlong30(batch_fd, total_written, 3);
367 write_varlong30(batch_fd, stats.total_size, 3);
368 if (protocol_version >= 29) {
369 write_varlong30(batch_fd, stats.flist_buildtime, 3);
370 write_varlong30(batch_fd, stats.flist_xfertime, 3);
375 static void output_itemized_counts(const char *prefix, int *counts)
377 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
378 char buf[1024], *pre = " (";
379 int j, len = 0;
380 int total = counts[0];
381 if (total) {
382 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
383 for (j = 0; j < 5; j++) {
384 if (counts[j]) {
385 len += snprintf(buf+len, sizeof buf - len - 2,
386 "%s%s: %s",
387 pre, labels[j], comma_num(counts[j]));
388 pre = ", ";
391 buf[len++] = ')';
393 buf[len] = '\0';
394 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
397 static const char *bytes_per_sec_human_dnum(void)
399 if (starttime == (time_t)-1 || endtime == (time_t)-1)
400 return "UNKNOWN";
401 return human_dnum((total_written + total_read) / (0.5 + (endtime - starttime)), 2);
404 static void output_summary(void)
406 if (INFO_GTE(STATS, 2)) {
407 rprintf(FCLIENT, "\n");
408 output_itemized_counts("Number of files", &stats.num_files);
409 if (protocol_version >= 29)
410 output_itemized_counts("Number of created files", &stats.created_files);
411 if (protocol_version >= 31)
412 output_itemized_counts("Number of deleted files", &stats.deleted_files);
413 rprintf(FINFO,"Number of regular files transferred: %s\n",
414 comma_num(stats.xferred_files));
415 rprintf(FINFO,"Total file size: %s bytes\n",
416 human_num(stats.total_size));
417 rprintf(FINFO,"Total transferred file size: %s bytes\n",
418 human_num(stats.total_transferred_size));
419 rprintf(FINFO,"Literal data: %s bytes\n",
420 human_num(stats.literal_data));
421 rprintf(FINFO,"Matched data: %s bytes\n",
422 human_num(stats.matched_data));
423 rprintf(FINFO,"File list size: %s\n",
424 human_num(stats.flist_size));
425 if (stats.flist_buildtime) {
426 rprintf(FINFO,
427 "File list generation time: %s seconds\n",
428 comma_dnum((double)stats.flist_buildtime / 1000, 3));
429 rprintf(FINFO,
430 "File list transfer time: %s seconds\n",
431 comma_dnum((double)stats.flist_xfertime / 1000, 3));
433 rprintf(FINFO,"Total bytes sent: %s\n",
434 human_num(total_written));
435 rprintf(FINFO,"Total bytes received: %s\n",
436 human_num(total_read));
439 if (INFO_GTE(STATS, 1)) {
440 rprintf(FCLIENT, "\n");
441 rprintf(FINFO,
442 "sent %s bytes received %s bytes %s bytes/sec\n",
443 human_num(total_written), human_num(total_read),
444 bytes_per_sec_human_dnum());
445 rprintf(FINFO, "total size is %s speedup is %s%s\n",
446 human_num(stats.total_size),
447 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
448 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
451 fflush(stdout);
452 fflush(stderr);
457 * If our C library can get malloc statistics, then show them to FINFO
459 static void show_malloc_stats(void)
461 #ifdef HAVE_MALLINFO
462 struct mallinfo mi;
464 mi = mallinfo();
466 rprintf(FCLIENT, "\n");
467 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
468 (int)getpid(), am_server ? "server " : "",
469 am_daemon ? "daemon " : "", who_am_i());
470 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
471 (long)mi.arena);
472 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
473 (long)mi.ordblks);
474 rprintf(FINFO, " smblks: %10ld\n",
475 (long)mi.smblks);
476 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
477 (long)mi.hblks);
478 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
479 (long)mi.hblkhd);
480 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
481 (long)mi.arena + mi.hblkhd);
482 rprintf(FINFO, " usmblks: %10ld\n",
483 (long)mi.usmblks);
484 rprintf(FINFO, " fsmblks: %10ld\n",
485 (long)mi.fsmblks);
486 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
487 (long)mi.uordblks);
488 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
489 (long)mi.fordblks);
490 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
491 (long)mi.keepcost);
492 #endif /* HAVE_MALLINFO */
496 /* Start the remote shell. cmd may be NULL to use the default. */
497 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
498 int *f_in_p, int *f_out_p)
500 int i, argc = 0;
501 char *args[MAX_ARGS], *need_to_free = NULL;
502 pid_t pid;
503 int dash_l_set = 0;
505 if (!read_batch && !local_server) {
506 char *t, *f, in_quote = '\0';
507 char *rsh_env = getenv(RSYNC_RSH_ENV);
508 if (!cmd)
509 cmd = rsh_env;
510 if (!cmd)
511 cmd = RSYNC_RSH;
512 cmd = need_to_free = strdup(cmd);
513 if (!cmd)
514 goto oom;
516 for (t = f = cmd; *f; f++) {
517 if (*f == ' ')
518 continue;
519 /* Comparison leaves rooms for server_options(). */
520 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
521 goto arg_overflow;
522 args[argc++] = t;
523 while (*f != ' ' || in_quote) {
524 if (!*f) {
525 if (in_quote) {
526 rprintf(FERROR,
527 "Missing trailing-%c in remote-shell command.\n",
528 in_quote);
529 exit_cleanup(RERR_SYNTAX);
531 f--;
532 break;
534 if (*f == '\'' || *f == '"') {
535 if (!in_quote) {
536 in_quote = *f++;
537 continue;
539 if (*f == in_quote && *++f != in_quote) {
540 in_quote = '\0';
541 continue;
544 *t++ = *f++;
546 *t++ = '\0';
549 /* check to see if we've already been given '-l user' in
550 * the remote-shell command */
551 for (i = 0; i < argc-1; i++) {
552 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
553 dash_l_set = 1;
556 #ifdef HAVE_REMSH
557 /* remsh (on HPUX) takes the arguments the other way around */
558 args[argc++] = machine;
559 if (user && !(daemon_over_rsh && dash_l_set)) {
560 args[argc++] = "-l";
561 args[argc++] = user;
563 #else
564 if (user && !(daemon_over_rsh && dash_l_set)) {
565 args[argc++] = "-l";
566 args[argc++] = user;
568 args[argc++] = machine;
569 #endif
571 args[argc++] = rsync_path;
573 if (blocking_io < 0) {
574 char *cp;
575 if ((cp = strrchr(cmd, '/')) != NULL)
576 cp++;
577 else
578 cp = cmd;
579 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
580 blocking_io = 1;
583 server_options(args,&argc);
585 if (argc >= MAX_ARGS - 2)
586 goto arg_overflow;
589 args[argc++] = ".";
591 if (!daemon_over_rsh) {
592 while (remote_argc > 0) {
593 if (argc >= MAX_ARGS - 1) {
594 arg_overflow:
595 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
596 exit_cleanup(RERR_SYNTAX);
598 if (**remote_argv == '-') {
599 if (asprintf(args + argc++, "./%s", *remote_argv++) < 0)
600 out_of_memory("do_cmd");
601 } else
602 args[argc++] = *remote_argv++;
603 remote_argc--;
607 args[argc] = NULL;
609 if (DEBUG_GTE(CMD, 2)) {
610 for (i = 0; i < argc; i++)
611 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
612 rprintf(FCLIENT, "\n");
615 if (read_batch) {
616 int from_gen_pipe[2];
617 set_allow_inc_recurse();
618 if (fd_pair(from_gen_pipe) < 0) {
619 rsyserr(FERROR, errno, "pipe");
620 exit_cleanup(RERR_IPC);
622 batch_gen_fd = from_gen_pipe[0];
623 *f_out_p = from_gen_pipe[1];
624 *f_in_p = batch_fd;
625 pid = (pid_t)-1; /* no child pid */
626 #ifdef ICONV_CONST
627 setup_iconv();
628 #endif
629 } else if (local_server) {
630 /* If the user didn't request --[no-]whole-file, force
631 * it on, but only if we're not batch processing. */
632 if (whole_file < 0 && !write_batch)
633 whole_file = 1;
634 set_allow_inc_recurse();
635 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
636 #ifdef ICONV_CONST
637 setup_iconv();
638 #endif
639 } else {
640 pid = piped_child(args, f_in_p, f_out_p);
641 #ifdef ICONV_CONST
642 setup_iconv();
643 #endif
644 if (protect_args && !daemon_over_rsh)
645 send_protected_args(*f_out_p, args);
648 if (need_to_free)
649 free(need_to_free);
651 return pid;
653 oom:
654 out_of_memory("do_cmd");
655 return 0; /* not reached */
658 /* The receiving side operates in one of two modes:
660 * 1. it receives any number of files into a destination directory,
661 * placing them according to their names in the file-list.
663 * 2. it receives a single file and saves it using the name in the
664 * destination path instead of its file-list name. This requires a
665 * "local name" for writing out the destination file.
667 * So, our task is to figure out what mode/local-name we need.
668 * For mode 1, we change into the destination directory and return NULL.
669 * For mode 2, we change into the directory containing the destination
670 * file (if we aren't already there) and return the local-name. */
671 static char *get_local_name(struct file_list *flist, char *dest_path)
673 STRUCT_STAT st;
674 int statret;
675 char *cp;
677 if (DEBUG_GTE(RECV, 1)) {
678 rprintf(FINFO, "get_local_name count=%d %s\n",
679 file_total, NS(dest_path));
682 if (!dest_path || list_only)
683 return NULL;
685 /* Treat an empty string as a copy into the current directory. */
686 if (!*dest_path)
687 dest_path = ".";
689 if (daemon_filter_list.head) {
690 char *slash = strrchr(dest_path, '/');
691 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
692 *slash = '\0';
693 else
694 slash = NULL;
695 if ((*dest_path != '.' || dest_path[1] != '\0')
696 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
697 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
698 rprintf(FERROR, "ERROR: daemon has excluded destination \"%s\"\n",
699 dest_path);
700 exit_cleanup(RERR_FILESELECT);
702 if (slash)
703 *slash = '/';
706 /* See what currently exists at the destination. */
707 if ((statret = do_stat(dest_path, &st)) == 0) {
708 /* If the destination is a dir, enter it and use mode 1. */
709 if (S_ISDIR(st.st_mode)) {
710 if (!change_dir(dest_path, CD_NORMAL)) {
711 rsyserr(FERROR, errno, "change_dir#1 %s failed",
712 full_fname(dest_path));
713 exit_cleanup(RERR_FILESELECT);
715 filesystem_dev = st.st_dev; /* ensures --force works right w/-x */
716 return NULL;
718 if (file_total > 1) {
719 rprintf(FERROR,
720 "ERROR: destination must be a directory when"
721 " copying more than 1 file\n");
722 exit_cleanup(RERR_FILESELECT);
724 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
725 rprintf(FERROR,
726 "ERROR: cannot overwrite non-directory"
727 " with a directory\n");
728 exit_cleanup(RERR_FILESELECT);
730 } else if (errno != ENOENT) {
731 /* If we don't know what's at the destination, fail. */
732 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
733 full_fname(dest_path));
734 exit_cleanup(RERR_FILESELECT);
737 cp = strrchr(dest_path, '/');
739 /* If we need a destination directory because the transfer is not
740 * of a single non-directory or the user has requested one via a
741 * destination path ending in a slash, create one and use mode 1. */
742 if (file_total > 1 || (cp && !cp[1])) {
743 /* Lop off the final slash (if any). */
744 if (cp && !cp[1])
745 *cp = '\0';
747 if (statret == 0) {
748 rprintf(FERROR,
749 "ERROR: destination path is not a directory\n");
750 exit_cleanup(RERR_SYNTAX);
753 if (do_mkdir(dest_path, ACCESSPERMS) != 0) {
754 rsyserr(FERROR, errno, "mkdir %s failed",
755 full_fname(dest_path));
756 exit_cleanup(RERR_FILEIO);
759 if (flist->high >= flist->low
760 && strcmp(flist->files[flist->low]->basename, ".") == 0)
761 flist->files[0]->flags |= FLAG_DIR_CREATED;
763 if (INFO_GTE(NAME, 1))
764 rprintf(FINFO, "created directory %s\n", dest_path);
766 if (dry_run) {
767 /* Indicate that dest dir doesn't really exist. */
768 dry_run++;
771 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
772 rsyserr(FERROR, errno, "change_dir#2 %s failed",
773 full_fname(dest_path));
774 exit_cleanup(RERR_FILESELECT);
777 return NULL;
780 /* Otherwise, we are writing a single file, possibly on top of an
781 * existing non-directory. Change to the item's parent directory
782 * (if it has a path component), return the basename of the
783 * destination file as the local name, and use mode 2. */
784 if (!cp)
785 return dest_path;
787 if (cp == dest_path)
788 dest_path = "/";
790 *cp = '\0';
791 if (!change_dir(dest_path, CD_NORMAL)) {
792 rsyserr(FERROR, errno, "change_dir#3 %s failed",
793 full_fname(dest_path));
794 exit_cleanup(RERR_FILESELECT);
796 *cp = '/';
798 return cp + 1;
801 /* This function checks on our alternate-basis directories. If we're in
802 * dry-run mode and the destination dir does not yet exist, we'll try to
803 * tweak any dest-relative paths to make them work for a dry-run (the
804 * destination dir must be in curr_dir[] when this function is called).
805 * We also warn about any arg that is non-existent or not a directory. */
806 static void check_alt_basis_dirs(void)
808 STRUCT_STAT st;
809 char *slash = strrchr(curr_dir, '/');
810 int j;
812 for (j = 0; j < basis_dir_cnt; j++) {
813 char *bdir = basis_dir[j];
814 int bd_len = strlen(bdir);
815 if (bd_len > 1 && bdir[bd_len-1] == '/')
816 bdir[--bd_len] = '\0';
817 if (dry_run > 1 && *bdir != '/') {
818 int len = curr_dir_len + 1 + bd_len + 1;
819 char *new = new_array(char, len);
820 if (!new)
821 out_of_memory("check_alt_basis_dirs");
822 if (slash && strncmp(bdir, "../", 3) == 0) {
823 /* We want to remove only one leading "../" prefix for
824 * the directory we couldn't create in dry-run mode:
825 * this ensures that any other ".." references get
826 * evaluated the same as they would for a live copy. */
827 *slash = '\0';
828 pathjoin(new, len, curr_dir, bdir + 3);
829 *slash = '/';
830 } else
831 pathjoin(new, len, curr_dir, bdir);
832 basis_dir[j] = bdir = new;
834 if (do_stat(bdir, &st) < 0)
835 rprintf(FWARNING, "%s arg does not exist: %s\n", dest_option, bdir);
836 else if (!S_ISDIR(st.st_mode))
837 rprintf(FWARNING, "%s arg is not a dir: %s\n", dest_option, bdir);
841 /* This is only called by the sender. */
842 static void read_final_goodbye(int f_in, int f_out)
844 int i, iflags, xlen;
845 uchar fnamecmp_type;
846 char xname[MAXPATHLEN];
848 shutting_down = True;
850 if (protocol_version < 29)
851 i = read_int(f_in);
852 else {
853 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
854 if (protocol_version >= 31 && i == NDX_DONE) {
855 if (am_sender)
856 write_ndx(f_out, NDX_DONE);
857 else {
858 if (batch_gen_fd >= 0) {
859 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
860 read_del_stats(batch_gen_fd);
862 write_int(f_out, NDX_DONE);
864 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
868 if (i != NDX_DONE) {
869 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
870 i, who_am_i());
871 exit_cleanup(RERR_PROTOCOL);
875 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
877 struct file_list *flist;
878 char *dir;
880 if (DEBUG_GTE(SEND, 1))
881 rprintf(FINFO, "server_sender starting pid=%d\n", (int)getpid());
883 if (am_daemon && lp_write_only(module_id)) {
884 rprintf(FERROR, "ERROR: module is write only\n");
885 exit_cleanup(RERR_SYNTAX);
887 if (am_daemon && read_only && remove_source_files) {
888 rprintf(FERROR,
889 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
890 remove_source_files == 1 ? "source" : "sent");
891 exit_cleanup(RERR_SYNTAX);
893 if (argc < 1) {
894 rprintf(FERROR, "ERROR: do_server_sender called without args\n");
895 exit_cleanup(RERR_SYNTAX);
898 become_copy_as_user();
900 dir = argv[0];
901 if (!relative_paths) {
902 if (!change_dir(dir, CD_NORMAL)) {
903 rsyserr(FERROR, errno, "change_dir#3 %s failed",
904 full_fname(dir));
905 exit_cleanup(RERR_FILESELECT);
908 argc--;
909 argv++;
911 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
912 argc = 1;
913 argv--;
914 argv[0] = ".";
917 flist = send_file_list(f_out,argc,argv);
918 if (!flist || flist->used == 0) {
919 /* Make sure input buffering is off so we can't hang in noop_io_until_death(). */
920 io_end_buffering_in(0);
921 /* TODO: we should really exit in a more controlled manner. */
922 exit_cleanup(0);
925 io_start_buffering_in(f_in);
927 send_files(f_in, f_out);
928 io_flush(FULL_FLUSH);
929 handle_stats(f_out);
930 if (protocol_version >= 24)
931 read_final_goodbye(f_in, f_out);
932 io_flush(FULL_FLUSH);
933 exit_cleanup(0);
937 static int do_recv(int f_in, int f_out, char *local_name)
939 int pid;
940 int exit_code = 0;
941 int error_pipe[2];
943 /* The receiving side mustn't obey this, or an existing symlink that
944 * points to an identical file won't be replaced by the referent. */
945 copy_links = copy_dirlinks = copy_unsafe_links = 0;
947 #ifdef SUPPORT_HARD_LINKS
948 if (preserve_hard_links && !inc_recurse)
949 match_hard_links(first_flist);
950 #endif
952 if (fd_pair(error_pipe) < 0) {
953 rsyserr(FERROR, errno, "pipe failed in do_recv");
954 exit_cleanup(RERR_IPC);
957 if (backup_dir) {
958 STRUCT_STAT st;
959 int ret;
960 if (backup_dir_len > 1)
961 backup_dir_buf[backup_dir_len-1] = '\0';
962 ret = do_stat(backup_dir_buf, &st);
963 if (ret != 0 || !S_ISDIR(st.st_mode)) {
964 if (ret == 0) {
965 rprintf(FERROR, "The backup-dir is not a directory: %s\n", backup_dir_buf);
966 exit_cleanup(RERR_SYNTAX);
968 if (errno != ENOENT) {
969 rprintf(FERROR, "Failed to stat %s: %s\n", backup_dir_buf, strerror(errno));
970 exit_cleanup(RERR_FILEIO);
972 if (INFO_GTE(BACKUP, 1))
973 rprintf(FINFO, "(new) backup_dir is %s\n", backup_dir_buf);
974 } else if (INFO_GTE(BACKUP, 1))
975 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
976 if (backup_dir_len > 1)
977 backup_dir_buf[backup_dir_len-1] = '/';
980 io_flush(FULL_FLUSH);
982 if ((pid = do_fork()) == -1) {
983 rsyserr(FERROR, errno, "fork failed in do_recv");
984 exit_cleanup(RERR_IPC);
987 if (pid == 0) {
988 am_receiver = 1;
989 send_msgs_to_gen = am_server;
991 close(error_pipe[0]);
993 /* We can't let two processes write to the socket at one time. */
994 io_end_multiplex_out(MPLX_SWITCHING);
995 if (f_in != f_out)
996 close(f_out);
997 sock_f_out = -1;
998 f_out = error_pipe[1];
1000 bwlimit_writemax = 0; /* receiver doesn't need to do this */
1002 if (read_batch)
1003 io_start_buffering_in(f_in);
1004 io_start_multiplex_out(f_out);
1006 recv_files(f_in, f_out, local_name);
1007 io_flush(FULL_FLUSH);
1008 handle_stats(f_in);
1010 if (output_needs_newline) {
1011 fputc('\n', stdout);
1012 output_needs_newline = 0;
1015 write_int(f_out, NDX_DONE);
1016 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
1017 io_flush(FULL_FLUSH);
1019 /* Handle any keep-alive packets from the post-processing work
1020 * that the generator does. */
1021 if (protocol_version >= 29) {
1022 kluge_around_eof = -1;
1024 /* This should only get stopped via a USR2 signal. */
1025 read_final_goodbye(f_in, f_out);
1027 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
1028 who_am_i());
1029 exit_cleanup(RERR_PROTOCOL);
1032 /* Finally, we go to sleep until our parent kills us with a
1033 * USR2 signal. We sleep for a short time, as on some OSes
1034 * a signal won't interrupt a sleep! */
1035 while (1)
1036 msleep(20);
1039 am_generator = 1;
1040 flist_receiving_enabled = True;
1042 io_end_multiplex_in(MPLX_SWITCHING);
1043 if (write_batch && !am_server)
1044 stop_write_batch();
1046 close(error_pipe[1]);
1047 if (f_in != f_out)
1048 close(f_in);
1049 sock_f_in = -1;
1050 f_in = error_pipe[0];
1052 io_start_buffering_out(f_out);
1053 io_start_multiplex_in(f_in);
1055 #ifdef SUPPORT_HARD_LINKS
1056 if (preserve_hard_links && inc_recurse) {
1057 struct file_list *flist;
1058 for (flist = first_flist; flist; flist = flist->next)
1059 match_hard_links(flist);
1061 #endif
1063 generate_files(f_out, local_name);
1065 handle_stats(-1);
1066 io_flush(FULL_FLUSH);
1067 shutting_down = True;
1068 if (protocol_version >= 24) {
1069 /* send a final goodbye message */
1070 write_ndx(f_out, NDX_DONE);
1072 io_flush(FULL_FLUSH);
1074 kill(pid, SIGUSR2);
1075 wait_process_with_flush(pid, &exit_code);
1076 return exit_code;
1079 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
1081 int exit_code;
1082 struct file_list *flist;
1083 char *local_name = NULL;
1084 int negated_levels;
1086 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
1087 /* We can't mix messages with files-from data on the socket,
1088 * so temporarily turn off info/debug messages. */
1089 negate_output_levels();
1090 negated_levels = 1;
1091 } else
1092 negated_levels = 0;
1094 if (DEBUG_GTE(RECV, 1))
1095 rprintf(FINFO, "server_recv(%d) starting pid=%d\n", argc, (int)getpid());
1097 if (am_daemon && read_only) {
1098 rprintf(FERROR,"ERROR: module is read only\n");
1099 exit_cleanup(RERR_SYNTAX);
1100 return;
1103 become_copy_as_user();
1105 if (argc > 0) {
1106 char *dir = argv[0];
1107 argc--;
1108 argv++;
1109 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
1110 rsyserr(FERROR, errno, "change_dir#4 %s failed",
1111 full_fname(dir));
1112 exit_cleanup(RERR_FILESELECT);
1116 if (protocol_version >= 30)
1117 io_start_multiplex_in(f_in);
1118 else
1119 io_start_buffering_in(f_in);
1120 recv_filter_list(f_in);
1122 if (filesfrom_fd >= 0) {
1123 /* We need to send the files-from names to the sender at the
1124 * same time that we receive the file-list from them, so we
1125 * need the IO routines to automatically write out the names
1126 * onto our f_out socket as we read the file-list. This
1127 * avoids both deadlock and extra delays/buffers. */
1128 start_filesfrom_forwarding(filesfrom_fd);
1129 filesfrom_fd = -1;
1132 flist = recv_file_list(f_in, -1);
1133 if (!flist) {
1134 rprintf(FERROR,"server_recv: recv_file_list error\n");
1135 exit_cleanup(RERR_FILESELECT);
1137 if (inc_recurse && file_total == 1)
1138 recv_additional_file_list(f_in);
1140 if (negated_levels)
1141 negate_output_levels();
1143 if (argc > 0)
1144 local_name = get_local_name(flist,argv[0]);
1146 /* Now that we know what our destination directory turned out to be,
1147 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1148 if (sanitize_paths) {
1149 char **dir_p;
1150 for (dir_p = basis_dir; *dir_p; dir_p++)
1151 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1152 if (partial_dir)
1153 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1155 check_alt_basis_dirs();
1157 if (daemon_filter_list.head) {
1158 char **dir_p;
1159 filter_rule_list *elp = &daemon_filter_list;
1161 for (dir_p = basis_dir; *dir_p; dir_p++) {
1162 char *dir = *dir_p;
1163 if (*dir == '/')
1164 dir += module_dirlen;
1165 if (check_filter(elp, FLOG, dir, 1) < 0)
1166 goto options_rejected;
1168 if (partial_dir && *partial_dir == '/'
1169 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1170 options_rejected:
1171 rprintf(FERROR,
1172 "Your options have been rejected by the server.\n");
1173 exit_cleanup(RERR_SYNTAX);
1177 exit_code = do_recv(f_in, f_out, local_name);
1178 exit_cleanup(exit_code);
1182 int child_main(int argc, char *argv[])
1184 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1185 return 0;
1189 void start_server(int f_in, int f_out, int argc, char *argv[])
1191 set_nonblocking(f_in);
1192 set_nonblocking(f_out);
1194 io_set_sock_fds(f_in, f_out);
1195 setup_protocol(f_out, f_in);
1197 if (protocol_version >= 23)
1198 io_start_multiplex_out(f_out);
1199 if (am_daemon && io_timeout && protocol_version >= 31)
1200 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1202 if (am_sender) {
1203 keep_dirlinks = 0; /* Must be disabled on the sender. */
1204 if (need_messages_from_generator)
1205 io_start_multiplex_in(f_in);
1206 else
1207 io_start_buffering_in(f_in);
1208 recv_filter_list(f_in);
1209 do_server_sender(f_in, f_out, argc, argv);
1210 } else
1211 do_server_recv(f_in, f_out, argc, argv);
1212 exit_cleanup(0);
1215 /* This is called once the connection has been negotiated. It is used
1216 * for rsyncd, remote-shell, and local connections. */
1217 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1219 struct file_list *flist = NULL;
1220 int exit_code = 0, exit_code2 = 0;
1221 char *local_name = NULL;
1223 cleanup_child_pid = pid;
1224 if (!read_batch) {
1225 set_nonblocking(f_in);
1226 set_nonblocking(f_out);
1229 io_set_sock_fds(f_in, f_out);
1230 setup_protocol(f_out,f_in);
1232 /* We set our stderr file handle to blocking because ssh might have
1233 * set it to non-blocking. This can be particularly troublesome if
1234 * stderr is a clone of stdout, because ssh would have set our stdout
1235 * to non-blocking at the same time (which can easily cause us to lose
1236 * output from our print statements). This kluge shouldn't cause ssh
1237 * any problems for how we use it. Note also that we delayed setting
1238 * this until after the above protocol setup so that we know for sure
1239 * that ssh is done twiddling its file descriptors. */
1240 set_blocking(STDERR_FILENO);
1242 if (am_sender) {
1243 keep_dirlinks = 0; /* Must be disabled on the sender. */
1245 if (always_checksum
1246 && (log_format_has(stdout_format, 'C')
1247 || log_format_has(logfile_format, 'C')))
1248 sender_keeps_checksum = 1;
1250 if (protocol_version >= 30)
1251 io_start_multiplex_out(f_out);
1252 else
1253 io_start_buffering_out(f_out);
1254 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1255 io_start_multiplex_in(f_in);
1256 else
1257 io_start_buffering_in(f_in);
1258 send_filter_list(f_out);
1259 if (filesfrom_host)
1260 filesfrom_fd = f_in;
1262 if (write_batch && !am_server)
1263 start_write_batch(f_out);
1265 become_copy_as_user();
1267 flist = send_file_list(f_out, argc, argv);
1268 if (DEBUG_GTE(FLIST, 3))
1269 rprintf(FINFO,"file list sent\n");
1271 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1272 io_start_multiplex_in(f_in);
1274 io_flush(NORMAL_FLUSH);
1275 send_files(f_in, f_out);
1276 io_flush(FULL_FLUSH);
1277 handle_stats(-1);
1278 if (protocol_version >= 24)
1279 read_final_goodbye(f_in, f_out);
1280 if (pid != -1) {
1281 if (DEBUG_GTE(EXIT, 2))
1282 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1283 io_flush(FULL_FLUSH);
1284 wait_process_with_flush(pid, &exit_code);
1286 output_summary();
1287 io_flush(FULL_FLUSH);
1288 exit_cleanup(exit_code);
1291 if (!read_batch) {
1292 if (protocol_version >= 23)
1293 io_start_multiplex_in(f_in);
1294 if (need_messages_from_generator)
1295 io_start_multiplex_out(f_out);
1296 else
1297 io_start_buffering_out(f_out);
1300 become_copy_as_user();
1302 send_filter_list(read_batch ? -1 : f_out);
1304 if (filesfrom_fd >= 0) {
1305 start_filesfrom_forwarding(filesfrom_fd);
1306 filesfrom_fd = -1;
1309 if (write_batch && !am_server)
1310 start_write_batch(f_in);
1311 flist = recv_file_list(f_in, -1);
1312 if (inc_recurse && file_total == 1)
1313 recv_additional_file_list(f_in);
1315 if (flist && flist->used > 0) {
1316 local_name = get_local_name(flist, argv[0]);
1318 check_alt_basis_dirs();
1320 exit_code2 = do_recv(f_in, f_out, local_name);
1321 } else {
1322 handle_stats(-1);
1323 output_summary();
1326 if (pid != -1) {
1327 if (DEBUG_GTE(RECV, 1))
1328 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1329 io_flush(FULL_FLUSH);
1330 wait_process_with_flush(pid, &exit_code);
1333 return MAX(exit_code, exit_code2);
1336 static int copy_argv(char *argv[])
1338 int i;
1340 for (i = 0; argv[i]; i++) {
1341 if (!(argv[i] = strdup(argv[i]))) {
1342 rprintf (FERROR, "out of memory at %s(%d)\n",
1343 __FILE__, __LINE__);
1344 return RERR_MALLOC;
1348 return 0;
1352 /* Start a client for either type of remote connection. Work out
1353 * whether the arguments request a remote shell or rsyncd connection,
1354 * and call the appropriate connection function, then run_client.
1356 * Calls either start_socket_client (for sockets) or do_cmd and
1357 * client_run (for ssh). */
1358 static int start_client(int argc, char *argv[])
1360 char *p, *shell_machine = NULL, *shell_user = NULL;
1361 char **remote_argv;
1362 int remote_argc, env_port = rsync_port;
1363 int f_in, f_out;
1364 int ret;
1365 pid_t pid;
1367 /* Don't clobber argv[] so that ps(1) can still show the right
1368 * command line. */
1369 if ((ret = copy_argv(argv)) != 0)
1370 return ret;
1372 if (!read_batch) { /* for read_batch, NO source is specified */
1373 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1374 if (path) { /* source is remote */
1375 char *dummy_host;
1376 int dummy_port = 0;
1377 *argv = path;
1378 remote_argv = argv;
1379 remote_argc = argc;
1380 argv += argc - 1;
1381 if (argc == 1 || **argv == ':')
1382 argc = 0; /* no dest arg */
1383 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1384 rprintf(FERROR,
1385 "The source and destination cannot both be remote.\n");
1386 exit_cleanup(RERR_SYNTAX);
1387 } else {
1388 remote_argc--; /* don't count dest */
1389 argc = 1;
1391 if (filesfrom_host && *filesfrom_host
1392 && strcmp(filesfrom_host, shell_machine) != 0) {
1393 rprintf(FERROR,
1394 "--files-from hostname is not the same as the transfer hostname\n");
1395 exit_cleanup(RERR_SYNTAX);
1397 am_sender = 0;
1398 if (rsync_port)
1399 daemon_over_rsh = shell_cmd ? 1 : -1;
1400 } else { /* source is local, check dest arg */
1401 am_sender = 1;
1403 if (argc > 1) {
1404 p = argv[--argc];
1405 remote_argv = argv + argc;
1406 } else {
1407 static char *dotarg[1] = { "." };
1408 p = dotarg[0];
1409 remote_argv = dotarg;
1411 remote_argc = 1;
1413 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1414 if (path && filesfrom_host && *filesfrom_host
1415 && strcmp(filesfrom_host, shell_machine) != 0) {
1416 rprintf(FERROR,
1417 "--files-from hostname is not the same as the transfer hostname\n");
1418 exit_cleanup(RERR_SYNTAX);
1420 if (!path) { /* no hostspec found, so src & dest are local */
1421 local_server = 1;
1422 if (filesfrom_host) {
1423 rprintf(FERROR,
1424 "--files-from cannot be remote when the transfer is local\n");
1425 exit_cleanup(RERR_SYNTAX);
1427 shell_machine = NULL;
1428 rsync_port = 0;
1429 } else { /* hostspec was found, so dest is remote */
1430 argv[argc] = path;
1431 if (rsync_port)
1432 daemon_over_rsh = shell_cmd ? 1 : -1;
1435 } else { /* read_batch */
1436 local_server = 1;
1437 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1438 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1439 exit_cleanup(RERR_SYNTAX);
1441 remote_argv = argv += argc - 1;
1442 remote_argc = argc = 1;
1443 rsync_port = 0;
1446 if (!rsync_port && remote_argc && !**remote_argv) /* Turn an empty arg into a dot dir. */
1447 *remote_argv = ".";
1449 if (am_sender) {
1450 char *dummy_host;
1451 int dummy_port = rsync_port;
1452 int i;
1453 /* For local source, extra source args must not have hostspec. */
1454 for (i = 1; i < argc; i++) {
1455 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1456 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1457 exit_cleanup(RERR_SYNTAX);
1460 } else {
1461 char *dummy_host;
1462 int dummy_port = rsync_port;
1463 int i;
1464 /* For remote source, any extra source args must have either
1465 * the same hostname or an empty hostname. */
1466 for (i = 1; i < remote_argc; i++) {
1467 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1468 if (!arg) {
1469 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1470 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1471 exit_cleanup(RERR_SYNTAX);
1473 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1474 rprintf(FERROR, "All source args must come from the same machine.\n");
1475 exit_cleanup(RERR_SYNTAX);
1477 if (rsync_port != dummy_port) {
1478 if (!rsync_port || !dummy_port)
1479 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1480 else
1481 rprintf(FERROR, "All source args must use the same port number.\n");
1482 exit_cleanup(RERR_SYNTAX);
1484 if (!rsync_port && !*arg) /* Turn an empty arg into a dot dir. */
1485 arg = ".";
1486 remote_argv[i] = arg;
1490 if (rsync_port < 0)
1491 rsync_port = RSYNC_PORT;
1492 else
1493 env_port = rsync_port;
1495 if (daemon_over_rsh < 0)
1496 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1498 if (password_file && !daemon_over_rsh) {
1499 rprintf(FERROR, "The --password-file option may only be "
1500 "used when accessing an rsync daemon.\n");
1501 exit_cleanup(RERR_SYNTAX);
1504 if (connect_timeout) {
1505 rprintf(FERROR, "The --contimeout option may only be "
1506 "used when connecting to an rsync daemon.\n");
1507 exit_cleanup(RERR_SYNTAX);
1510 if (shell_machine) {
1511 p = strrchr(shell_machine,'@');
1512 if (p) {
1513 *p = 0;
1514 shell_user = shell_machine;
1515 shell_machine = p+1;
1519 if (DEBUG_GTE(CMD, 2)) {
1520 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1521 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1522 NS(remote_argv[0]));
1525 #ifdef HAVE_PUTENV
1526 if (daemon_over_rsh)
1527 set_env_num("RSYNC_PORT", env_port);
1528 #endif
1530 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1531 &f_in, &f_out);
1533 /* if we're running an rsync server on the remote host over a
1534 * remote shell command, we need to do the RSYNCD protocol first */
1535 if (daemon_over_rsh) {
1536 int tmpret;
1537 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1538 if (tmpret < 0)
1539 return tmpret;
1542 ret = client_run(f_in, f_out, pid, argc, argv);
1544 fflush(stdout);
1545 fflush(stderr);
1547 return ret;
1551 static void sigusr1_handler(UNUSED(int val))
1553 called_from_signal_handler = 1;
1554 exit_cleanup(RERR_SIGNAL1);
1557 static void sigusr2_handler(UNUSED(int val))
1559 if (!am_server)
1560 output_summary();
1561 close_all();
1562 if (got_xfer_error)
1563 _exit(RERR_PARTIAL);
1564 _exit(0);
1567 static void siginfo_handler(UNUSED(int val))
1569 if (!am_server && !INFO_GTE(PROGRESS, 1))
1570 want_progress_now = True;
1573 void remember_children(UNUSED(int val))
1575 #ifdef WNOHANG
1576 int cnt, status;
1577 pid_t pid;
1578 /* An empty waitpid() loop was put here by Tridge and we could never
1579 * get him to explain why he put it in, so rather than taking it
1580 * out we're instead saving the child exit statuses for later use.
1581 * The waitpid() loop presumably eliminates all possibility of leaving
1582 * zombie children, maybe that's why he did it. */
1583 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1584 /* save the child's exit status */
1585 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1586 if (pid_stat_table[cnt].pid == 0) {
1587 pid_stat_table[cnt].pid = pid;
1588 pid_stat_table[cnt].status = status;
1589 break;
1593 #endif
1594 #ifndef HAVE_SIGACTION
1595 signal(SIGCHLD, remember_children);
1596 #endif
1601 * This routine catches signals and tries to send them to gdb.
1603 * Because it's called from inside a signal handler it ought not to
1604 * use too many library routines.
1606 * @todo Perhaps use "screen -X" instead/as well, to help people
1607 * debugging without easy access to X. Perhaps use an environment
1608 * variable, or just call a script?
1610 * @todo The /proc/ magic probably only works on Linux (and
1611 * Solaris?) Can we be more portable?
1613 #ifdef MAINTAINER_MODE
1614 const char *get_panic_action(void)
1616 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1618 if (cmd_fmt)
1619 return cmd_fmt;
1620 return "xterm -display :0 -T Panic -n Panic -e gdb /proc/%d/exe %d";
1625 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1627 * This signal handler is only installed if we were configured with
1628 * --enable-maintainer-mode. Perhaps it should always be on and we
1629 * should just look at the environment variable, but I'm a bit leery
1630 * of a signal sending us into a busy loop.
1632 static void rsync_panic_handler(UNUSED(int whatsig))
1634 char cmd_buf[300];
1635 int ret, pid_int = getpid();
1637 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(), pid_int, pid_int);
1639 /* Unless we failed to execute gdb, we allow the process to
1640 * continue. I'm not sure if that's right. */
1641 ret = shell_exec(cmd_buf);
1642 if (ret)
1643 _exit(ret);
1645 #endif
1648 int main(int argc,char *argv[])
1650 int ret;
1651 int orig_argc = argc;
1652 char **orig_argv = argv;
1653 #ifdef HAVE_SIGACTION
1654 # ifdef HAVE_SIGPROCMASK
1655 sigset_t sigmask;
1657 sigemptyset(&sigmask);
1658 # endif
1659 sigact.sa_flags = SA_NOCLDSTOP;
1660 #endif
1661 SIGACTMASK(SIGUSR1, sigusr1_handler);
1662 SIGACTMASK(SIGUSR2, sigusr2_handler);
1663 SIGACTMASK(SIGCHLD, remember_children);
1664 #ifdef MAINTAINER_MODE
1665 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1666 SIGACTMASK(SIGFPE, rsync_panic_handler);
1667 SIGACTMASK(SIGABRT, rsync_panic_handler);
1668 SIGACTMASK(SIGBUS, rsync_panic_handler);
1669 #endif
1670 #ifdef SIGINFO
1671 SIGACTMASK(SIGINFO, siginfo_handler);
1672 #endif
1673 #ifdef SIGVTALRM
1674 SIGACTMASK(SIGVTALRM, siginfo_handler);
1675 #endif
1677 starttime = time(NULL);
1678 our_uid = MY_UID();
1679 our_gid = MY_GID();
1680 am_root = our_uid == 0;
1682 memset(&stats, 0, sizeof(stats));
1684 /* Even a non-daemon runs needs the default config values to be set, e.g.
1685 * lp_dont_compress() is queried when no --skip-compress option is set. */
1686 reset_daemon_vars();
1688 if (argc < 2) {
1689 usage(FERROR);
1690 exit_cleanup(RERR_SYNTAX);
1693 /* Get the umask for use in permission calculations. We no longer set
1694 * it to zero; that is ugly and pointless now that all the callers that
1695 * relied on it have been reeducated to work with default ACLs. */
1696 umask(orig_umask = umask(0));
1698 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1699 setlocale(LC_CTYPE, "");
1700 #endif
1702 if (!parse_arguments(&argc, (const char ***) &argv)) {
1703 option_error();
1704 exit_cleanup(RERR_SYNTAX);
1707 SIGACTMASK(SIGINT, sig_int);
1708 SIGACTMASK(SIGHUP, sig_int);
1709 SIGACTMASK(SIGTERM, sig_int);
1710 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1711 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1712 #endif
1714 /* Ignore SIGPIPE; we consistently check error codes and will
1715 * see the EPIPE. */
1716 SIGACTION(SIGPIPE, SIG_IGN);
1717 #ifdef SIGXFSZ
1718 SIGACTION(SIGXFSZ, SIG_IGN);
1719 #endif
1721 /* Initialize change_dir() here because on some old systems getcwd
1722 * (implemented by forking "pwd" and reading its output) doesn't
1723 * work when there are other child processes. Also, on all systems
1724 * that implement getcwd that way "pwd" can't be found after chroot. */
1725 change_dir(NULL, CD_NORMAL);
1727 if ((write_batch || read_batch) && !am_server) {
1728 if (write_batch)
1729 write_batch_shell_file(orig_argc, orig_argv, argc, argv);
1731 if (read_batch && strcmp(batch_name, "-") == 0)
1732 batch_fd = STDIN_FILENO;
1733 else {
1734 batch_fd = do_open(batch_name,
1735 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1736 : O_RDONLY, S_IRUSR | S_IWUSR);
1738 if (batch_fd < 0) {
1739 rsyserr(FERROR, errno, "Batch file %s open error",
1740 full_fname(batch_name));
1741 exit_cleanup(RERR_FILEIO);
1743 if (read_batch)
1744 read_stream_flags(batch_fd);
1745 else
1746 write_stream_flags(batch_fd);
1748 if (write_batch < 0)
1749 dry_run = 1;
1751 if (am_server) {
1752 #ifdef ICONV_CONST
1753 setup_iconv();
1754 #endif
1755 } else if (am_daemon)
1756 return daemon_main();
1758 if (am_server && protect_args) {
1759 char buf[MAXPATHLEN];
1760 protect_args = 2;
1761 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1762 if (!parse_arguments(&argc, (const char ***) &argv)) {
1763 option_error();
1764 exit_cleanup(RERR_SYNTAX);
1768 if (argc < 1) {
1769 usage(FERROR);
1770 exit_cleanup(RERR_SYNTAX);
1773 if (am_server) {
1774 set_nonblocking(STDIN_FILENO);
1775 set_nonblocking(STDOUT_FILENO);
1776 if (am_daemon)
1777 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1778 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1781 ret = start_client(argc, argv);
1782 if (ret == -1)
1783 exit_cleanup(RERR_STARTCLIENT);
1784 else
1785 exit_cleanup(ret);
1787 return ret;