Document the "copy-some-dirlinks" trick in the man page.
[rsync/rsync.git] / main.c
... / ...
CommitLineData
1/*
2 * The startup routines, including main(), for rsync.
3 *
4 * Copyright (C) 1996-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2003-2009 Wayne Davison
8 *
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.
13 *
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.
18 *
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.
21 */
22
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
29
30extern int dry_run;
31extern int list_only;
32extern int io_timeout;
33extern int am_root;
34extern int am_server;
35extern int am_sender;
36extern int am_daemon;
37extern int inc_recurse;
38extern int blocking_io;
39extern int always_checksum;
40extern int remove_source_files;
41extern int output_needs_newline;
42extern int need_messages_from_generator;
43extern int kluge_around_eof;
44extern int got_xfer_error;
45extern int msgs2stderr;
46extern int module_id;
47extern int read_only;
48extern int copy_links;
49extern int copy_dirlinks;
50extern int copy_unsafe_links;
51extern int keep_dirlinks;
52extern int preserve_hard_links;
53extern int protocol_version;
54extern int file_total;
55extern int recurse;
56extern int xfer_dirs;
57extern int protect_args;
58extern int relative_paths;
59extern int sanitize_paths;
60extern int curr_dir_depth;
61extern int curr_dir_len;
62extern int module_id;
63extern int rsync_port;
64extern int whole_file;
65extern int read_batch;
66extern int write_batch;
67extern int batch_fd;
68extern int sock_f_in;
69extern int sock_f_out;
70extern int filesfrom_fd;
71extern int connect_timeout;
72extern int send_msgs_to_gen;
73extern pid_t cleanup_child_pid;
74extern size_t bwlimit_writemax;
75extern unsigned int module_dirlen;
76extern BOOL flist_receiving_enabled;
77extern BOOL shutting_down;
78extern struct stats stats;
79extern char *stdout_format;
80extern char *logfile_format;
81extern char *filesfrom_host;
82extern char *partial_dir;
83extern char *dest_option;
84extern char *rsync_path;
85extern char *shell_cmd;
86extern char *batch_name;
87extern char *password_file;
88extern char *backup_dir;
89extern char curr_dir[MAXPATHLEN];
90extern char backup_dir_buf[MAXPATHLEN];
91extern char *basis_dir[MAX_BASIS_DIRS+1];
92extern struct file_list *first_flist;
93extern filter_rule_list daemon_filter_list;
94
95uid_t our_uid;
96gid_t our_gid;
97int am_receiver = 0; /* Only set to 1 after the receiver/generator fork. */
98int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
99int local_server = 0;
100int daemon_over_rsh = 0;
101mode_t orig_umask = 0;
102int batch_gen_fd = -1;
103int sender_keeps_checksum = 0;
104
105/* There's probably never more than at most 2 outstanding child processes,
106 * but set it higher, just in case. */
107#define MAXCHILDPROCS 7
108
109#ifdef HAVE_SIGACTION
110# ifdef HAVE_SIGPROCMASK
111# define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
112# else
113# define SIGACTMASK(n,h) SIGACTION(n,h)
114# endif
115static struct sigaction sigact;
116#endif
117
118struct pid_status {
119 pid_t pid;
120 int status;
121} pid_stat_table[MAXCHILDPROCS];
122
123static time_t starttime, endtime;
124static int64 total_read, total_written;
125
126static void show_malloc_stats(void);
127
128/* Works like waitpid(), but if we already harvested the child pid in our
129 * remember_children(), we succeed instead of returning an error. */
130pid_t wait_process(pid_t pid, int *status_ptr, int flags)
131{
132 pid_t waited_pid;
133
134 do {
135 waited_pid = waitpid(pid, status_ptr, flags);
136 } while (waited_pid == -1 && errno == EINTR);
137
138 if (waited_pid == -1 && errno == ECHILD) {
139 /* Status of requested child no longer available: check to
140 * see if it was processed by remember_children(). */
141 int cnt;
142 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
143 if (pid == pid_stat_table[cnt].pid) {
144 *status_ptr = pid_stat_table[cnt].status;
145 pid_stat_table[cnt].pid = 0;
146 return pid;
147 }
148 }
149 }
150
151 return waited_pid;
152}
153
154/* Wait for a process to exit, calling io_flush while waiting. */
155static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
156{
157 pid_t waited_pid;
158 int status;
159
160 while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
161 msleep(20);
162 io_flush(FULL_FLUSH);
163 }
164
165 /* TODO: If the child exited on a signal, then log an
166 * appropriate error message. Perhaps we should also accept a
167 * message describing the purpose of the child. Also indicate
168 * this to the caller so that they know something went wrong. */
169 if (waited_pid < 0) {
170 rsyserr(FERROR, errno, "waitpid");
171 *exit_code_ptr = RERR_WAITCHILD;
172 } else if (!WIFEXITED(status)) {
173#ifdef WCOREDUMP
174 if (WCOREDUMP(status))
175 *exit_code_ptr = RERR_CRASHED;
176 else
177#endif
178 if (WIFSIGNALED(status))
179 *exit_code_ptr = RERR_TERMINATED;
180 else
181 *exit_code_ptr = RERR_WAITCHILD;
182 } else
183 *exit_code_ptr = WEXITSTATUS(status);
184}
185
186void write_del_stats(int f)
187{
188 if (read_batch)
189 write_int(f, NDX_DEL_STATS);
190 else
191 write_ndx(f, NDX_DEL_STATS);
192 write_varint(f, stats.deleted_files - stats.deleted_dirs
193 - stats.deleted_symlinks - stats.deleted_devices
194 - stats.deleted_specials);
195 write_varint(f, stats.deleted_dirs);
196 write_varint(f, stats.deleted_symlinks);
197 write_varint(f, stats.deleted_devices);
198 write_varint(f, stats.deleted_specials);
199}
200
201void read_del_stats(int f)
202{
203 stats.deleted_files = read_varint(f);
204 stats.deleted_files += stats.deleted_dirs = read_varint(f);
205 stats.deleted_files += stats.deleted_symlinks = read_varint(f);
206 stats.deleted_files += stats.deleted_devices = read_varint(f);
207 stats.deleted_files += stats.deleted_specials = read_varint(f);
208}
209
210/* This function gets called from all 3 processes. We want the client side
211 * to actually output the text, but the sender is the only process that has
212 * all the stats we need. So, if we're a client sender, we do the report.
213 * If we're a server sender, we write the stats on the supplied fd. If
214 * we're the client receiver we read the stats from the supplied fd and do
215 * the report. All processes might also generate a set of debug stats, if
216 * the verbose level is high enough (this is the only thing that the
217 * generator process and the server receiver ever do here). */
218static void handle_stats(int f)
219{
220 endtime = time(NULL);
221
222 /* Cache two stats because the read/write code can change it. */
223 total_read = stats.total_read;
224 total_written = stats.total_written;
225
226 if (INFO_GTE(STATS, 3)) {
227 /* These come out from every process */
228 show_malloc_stats();
229 show_flist_stats();
230 }
231
232 if (am_generator)
233 return;
234
235 if (am_daemon) {
236 if (f == -1 || !am_sender)
237 return;
238 }
239
240 if (am_server) {
241 if (am_sender) {
242 write_varlong30(f, total_read, 3);
243 write_varlong30(f, total_written, 3);
244 write_varlong30(f, stats.total_size, 3);
245 if (protocol_version >= 29) {
246 write_varlong30(f, stats.flist_buildtime, 3);
247 write_varlong30(f, stats.flist_xfertime, 3);
248 }
249 }
250 return;
251 }
252
253 /* this is the client */
254
255 if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
256 ;
257 else if (!am_sender) {
258 /* Read the first two in opposite order because the meaning of
259 * read/write swaps when switching from sender to receiver. */
260 total_written = read_varlong30(f, 3);
261 total_read = read_varlong30(f, 3);
262 stats.total_size = read_varlong30(f, 3);
263 if (protocol_version >= 29) {
264 stats.flist_buildtime = read_varlong30(f, 3);
265 stats.flist_xfertime = read_varlong30(f, 3);
266 }
267 } else if (write_batch) {
268 /* The --read-batch process is going to be a client
269 * receiver, so we need to give it the stats. */
270 write_varlong30(batch_fd, total_read, 3);
271 write_varlong30(batch_fd, total_written, 3);
272 write_varlong30(batch_fd, stats.total_size, 3);
273 if (protocol_version >= 29) {
274 write_varlong30(batch_fd, stats.flist_buildtime, 3);
275 write_varlong30(batch_fd, stats.flist_xfertime, 3);
276 }
277 }
278}
279
280static void output_itemized_counts(const char *prefix, int *counts)
281{
282 static char *labels[] = { "reg", "dir", "link", "dev", "special" };
283 char buf[1024], *pre = " (";
284 int j, len = 0;
285 int total = counts[0];
286 if (total) {
287 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
288 for (j = 0; j < 5; j++) {
289 if (counts[j]) {
290 len += snprintf(buf+len, sizeof buf - len - 2,
291 "%s%s: %s",
292 pre, labels[j], comma_num(counts[j]));
293 pre = ", ";
294 }
295 }
296 buf[len++] = ')';
297 }
298 buf[len] = '\0';
299 rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
300}
301
302static void output_summary(void)
303{
304 if (INFO_GTE(STATS, 2)) {
305 rprintf(FCLIENT, "\n");
306 output_itemized_counts("Number of files", &stats.num_files);
307 if (protocol_version >= 29)
308 output_itemized_counts("Number of created files", &stats.created_files);
309 if (protocol_version >= 31)
310 output_itemized_counts("Number of deleted files", &stats.deleted_files);
311 rprintf(FINFO,"Number of regular files transferred: %s\n",
312 comma_num(stats.xferred_files));
313 rprintf(FINFO,"Total file size: %s bytes\n",
314 human_num(stats.total_size));
315 rprintf(FINFO,"Total transferred file size: %s bytes\n",
316 human_num(stats.total_transferred_size));
317 rprintf(FINFO,"Literal data: %s bytes\n",
318 human_num(stats.literal_data));
319 rprintf(FINFO,"Matched data: %s bytes\n",
320 human_num(stats.matched_data));
321 rprintf(FINFO,"File list size: %s\n",
322 human_num(stats.flist_size));
323 if (stats.flist_buildtime) {
324 rprintf(FINFO,
325 "File list generation time: %s seconds\n",
326 comma_dnum((double)stats.flist_buildtime / 1000, 3));
327 rprintf(FINFO,
328 "File list transfer time: %s seconds\n",
329 comma_dnum((double)stats.flist_xfertime / 1000, 3));
330 }
331 rprintf(FINFO,"Total bytes sent: %s\n",
332 human_num(total_written));
333 rprintf(FINFO,"Total bytes received: %s\n",
334 human_num(total_read));
335 }
336
337 if (INFO_GTE(STATS, 1)) {
338 rprintf(FCLIENT, "\n");
339 rprintf(FINFO,
340 "sent %s bytes received %s bytes %s bytes/sec\n",
341 human_num(total_written), human_num(total_read),
342 human_dnum((total_written + total_read)/(0.5 + (endtime - starttime)), 2));
343 rprintf(FINFO, "total size is %s speedup is %s%s\n",
344 human_num(stats.total_size),
345 comma_dnum((double)stats.total_size / (total_written+total_read), 2),
346 write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
347 }
348
349 fflush(stdout);
350 fflush(stderr);
351}
352
353
354/**
355 * If our C library can get malloc statistics, then show them to FINFO
356 **/
357static void show_malloc_stats(void)
358{
359#ifdef HAVE_MALLINFO
360 struct mallinfo mi;
361
362 mi = mallinfo();
363
364 rprintf(FCLIENT, "\n");
365 rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
366 getpid(), am_server ? "server " : "",
367 am_daemon ? "daemon " : "", who_am_i());
368 rprintf(FINFO, " arena: %10ld (bytes from sbrk)\n",
369 (long)mi.arena);
370 rprintf(FINFO, " ordblks: %10ld (chunks not in use)\n",
371 (long)mi.ordblks);
372 rprintf(FINFO, " smblks: %10ld\n",
373 (long)mi.smblks);
374 rprintf(FINFO, " hblks: %10ld (chunks from mmap)\n",
375 (long)mi.hblks);
376 rprintf(FINFO, " hblkhd: %10ld (bytes from mmap)\n",
377 (long)mi.hblkhd);
378 rprintf(FINFO, " allmem: %10ld (bytes from sbrk + mmap)\n",
379 (long)mi.arena + mi.hblkhd);
380 rprintf(FINFO, " usmblks: %10ld\n",
381 (long)mi.usmblks);
382 rprintf(FINFO, " fsmblks: %10ld\n",
383 (long)mi.fsmblks);
384 rprintf(FINFO, " uordblks: %10ld (bytes used)\n",
385 (long)mi.uordblks);
386 rprintf(FINFO, " fordblks: %10ld (bytes free)\n",
387 (long)mi.fordblks);
388 rprintf(FINFO, " keepcost: %10ld (bytes in releasable chunk)\n",
389 (long)mi.keepcost);
390#endif /* HAVE_MALLINFO */
391}
392
393
394/* Start the remote shell. cmd may be NULL to use the default. */
395static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
396 int *f_in_p, int *f_out_p)
397{
398 int i, argc = 0;
399 char *args[MAX_ARGS], *need_to_free = NULL;
400 pid_t pid;
401 int dash_l_set = 0;
402
403 if (!read_batch && !local_server) {
404 char *t, *f, in_quote = '\0';
405 char *rsh_env = getenv(RSYNC_RSH_ENV);
406 if (!cmd)
407 cmd = rsh_env;
408 if (!cmd)
409 cmd = RSYNC_RSH;
410 cmd = need_to_free = strdup(cmd);
411 if (!cmd)
412 goto oom;
413
414 for (t = f = cmd; *f; f++) {
415 if (*f == ' ')
416 continue;
417 /* Comparison leaves rooms for server_options(). */
418 if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
419 goto arg_overflow;
420 args[argc++] = t;
421 while (*f != ' ' || in_quote) {
422 if (!*f) {
423 if (in_quote) {
424 rprintf(FERROR,
425 "Missing trailing-%c in remote-shell command.\n",
426 in_quote);
427 exit_cleanup(RERR_SYNTAX);
428 }
429 f--;
430 break;
431 }
432 if (*f == '\'' || *f == '"') {
433 if (!in_quote) {
434 in_quote = *f++;
435 continue;
436 }
437 if (*f == in_quote && *++f != in_quote) {
438 in_quote = '\0';
439 continue;
440 }
441 }
442 *t++ = *f++;
443 }
444 *t++ = '\0';
445 }
446
447 /* check to see if we've already been given '-l user' in
448 * the remote-shell command */
449 for (i = 0; i < argc-1; i++) {
450 if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
451 dash_l_set = 1;
452 }
453
454#ifdef HAVE_REMSH
455 /* remsh (on HPUX) takes the arguments the other way around */
456 args[argc++] = machine;
457 if (user && !(daemon_over_rsh && dash_l_set)) {
458 args[argc++] = "-l";
459 args[argc++] = user;
460 }
461#else
462 if (user && !(daemon_over_rsh && dash_l_set)) {
463 args[argc++] = "-l";
464 args[argc++] = user;
465 }
466 args[argc++] = machine;
467#endif
468
469 args[argc++] = rsync_path;
470
471 if (blocking_io < 0) {
472 char *cp;
473 if ((cp = strrchr(cmd, '/')) != NULL)
474 cp++;
475 else
476 cp = cmd;
477 if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
478 blocking_io = 1;
479 }
480
481 server_options(args,&argc);
482
483 if (argc >= MAX_ARGS - 2)
484 goto arg_overflow;
485 }
486
487 args[argc++] = ".";
488
489 if (!daemon_over_rsh) {
490 while (remote_argc > 0) {
491 if (argc >= MAX_ARGS - 1) {
492 arg_overflow:
493 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
494 exit_cleanup(RERR_SYNTAX);
495 }
496 args[argc++] = *remote_argv++;
497 remote_argc--;
498 }
499 }
500
501 args[argc] = NULL;
502
503 if (DEBUG_GTE(CMD, 2)) {
504 for (i = 0; i < argc; i++)
505 rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
506 rprintf(FCLIENT, "\n");
507 }
508
509 if (read_batch) {
510 int from_gen_pipe[2];
511 set_allow_inc_recurse();
512 if (fd_pair(from_gen_pipe) < 0) {
513 rsyserr(FERROR, errno, "pipe");
514 exit_cleanup(RERR_IPC);
515 }
516 batch_gen_fd = from_gen_pipe[0];
517 *f_out_p = from_gen_pipe[1];
518 *f_in_p = batch_fd;
519 pid = (pid_t)-1; /* no child pid */
520#ifdef ICONV_CONST
521 setup_iconv();
522#endif
523 } else if (local_server) {
524 /* If the user didn't request --[no-]whole-file, force
525 * it on, but only if we're not batch processing. */
526 if (whole_file < 0 && !write_batch)
527 whole_file = 1;
528 set_allow_inc_recurse();
529 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
530#ifdef ICONV_CONST
531 setup_iconv();
532#endif
533 } else {
534 pid = piped_child(args, f_in_p, f_out_p);
535#ifdef ICONV_CONST
536 setup_iconv();
537#endif
538 if (protect_args && !daemon_over_rsh)
539 send_protected_args(*f_out_p, args);
540 }
541
542 if (need_to_free)
543 free(need_to_free);
544
545 return pid;
546
547 oom:
548 out_of_memory("do_cmd");
549 return 0; /* not reached */
550}
551
552/* The receiving side operates in one of two modes:
553 *
554 * 1. it receives any number of files into a destination directory,
555 * placing them according to their names in the file-list.
556 *
557 * 2. it receives a single file and saves it using the name in the
558 * destination path instead of its file-list name. This requires a
559 * "local name" for writing out the destination file.
560 *
561 * So, our task is to figure out what mode/local-name we need.
562 * For mode 1, we change into the destination directory and return NULL.
563 * For mode 2, we change into the directory containing the destination
564 * file (if we aren't already there) and return the local-name. */
565static char *get_local_name(struct file_list *flist, char *dest_path)
566{
567 STRUCT_STAT st;
568 int statret;
569 char *cp;
570
571 if (DEBUG_GTE(RECV, 1)) {
572 rprintf(FINFO, "get_local_name count=%d %s\n",
573 file_total, NS(dest_path));
574 }
575
576 if (!dest_path || list_only)
577 return NULL;
578
579 if (daemon_filter_list.head) {
580 char *slash = strrchr(dest_path, '/');
581 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
582 *slash = '\0';
583 else
584 slash = NULL;
585 if ((*dest_path != '.' || dest_path[1] != '\0')
586 && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
587 || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
588 rprintf(FERROR, "skipping daemon-excluded destination \"%s\"\n",
589 dest_path);
590 exit_cleanup(RERR_FILESELECT);
591 }
592 if (slash)
593 *slash = '/';
594 }
595
596 /* See what currently exists at the destination. */
597 if ((statret = do_stat(dest_path, &st)) == 0) {
598 /* If the destination is a dir, enter it and use mode 1. */
599 if (S_ISDIR(st.st_mode)) {
600 if (!change_dir(dest_path, CD_NORMAL)) {
601 rsyserr(FERROR, errno, "change_dir#1 %s failed",
602 full_fname(dest_path));
603 exit_cleanup(RERR_FILESELECT);
604 }
605 return NULL;
606 }
607 if (file_total > 1) {
608 rprintf(FERROR,
609 "ERROR: destination must be a directory when"
610 " copying more than 1 file\n");
611 exit_cleanup(RERR_FILESELECT);
612 }
613 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
614 rprintf(FERROR,
615 "ERROR: cannot overwrite non-directory"
616 " with a directory\n");
617 exit_cleanup(RERR_FILESELECT);
618 }
619 } else if (errno != ENOENT) {
620 /* If we don't know what's at the destination, fail. */
621 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
622 full_fname(dest_path));
623 exit_cleanup(RERR_FILESELECT);
624 }
625
626 cp = strrchr(dest_path, '/');
627
628 /* If we need a destination directory because the transfer is not
629 * of a single non-directory or the user has requested one via a
630 * destination path ending in a slash, create one and use mode 1. */
631 if (file_total > 1 || (cp && !cp[1])) {
632 /* Lop off the final slash (if any). */
633 if (cp && !cp[1])
634 *cp = '\0';
635
636 if (statret == 0) {
637 rprintf(FERROR,
638 "ERROR: destination path is not a directory\n");
639 exit_cleanup(RERR_SYNTAX);
640 }
641
642 if (mkdir_defmode(dest_path) != 0) {
643 rsyserr(FERROR, errno, "mkdir %s failed",
644 full_fname(dest_path));
645 exit_cleanup(RERR_FILEIO);
646 }
647
648 if (flist->high >= flist->low
649 && strcmp(flist->files[flist->low]->basename, ".") == 0)
650 flist->files[0]->flags |= FLAG_DIR_CREATED;
651
652 if (INFO_GTE(NAME, 1))
653 rprintf(FINFO, "created directory %s\n", dest_path);
654
655 if (dry_run) {
656 /* Indicate that dest dir doesn't really exist. */
657 dry_run++;
658 }
659
660 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
661 rsyserr(FERROR, errno, "change_dir#2 %s failed",
662 full_fname(dest_path));
663 exit_cleanup(RERR_FILESELECT);
664 }
665
666 return NULL;
667 }
668
669 /* Otherwise, we are writing a single file, possibly on top of an
670 * existing non-directory. Change to the item's parent directory
671 * (if it has a path component), return the basename of the
672 * destination file as the local name, and use mode 2. */
673 if (!cp)
674 return dest_path;
675
676 if (cp == dest_path)
677 dest_path = "/";
678
679 *cp = '\0';
680 if (!change_dir(dest_path, CD_NORMAL)) {
681 rsyserr(FERROR, errno, "change_dir#3 %s failed",
682 full_fname(dest_path));
683 exit_cleanup(RERR_FILESELECT);
684 }
685 *cp = '/';
686
687 return cp + 1;
688}
689
690/* This function checks on our alternate-basis directories. If we're in
691 * dry-run mode and the destination dir does not yet exist, we'll try to
692 * tweak any dest-relative paths to make them work for a dry-run (the
693 * destination dir must be in curr_dir[] when this function is called).
694 * We also warn about any arg that is non-existent or not a directory. */
695static void check_alt_basis_dirs(void)
696{
697 STRUCT_STAT st;
698 char **dir_p, *slash = strrchr(curr_dir, '/');
699
700 for (dir_p = basis_dir; *dir_p; dir_p++) {
701 if (dry_run > 1 && **dir_p != '/') {
702 int len = curr_dir_len + 1 + strlen(*dir_p) + 1;
703 char *new = new_array(char, len);
704 if (!new)
705 out_of_memory("check_alt_basis_dirs");
706 if (slash && strncmp(*dir_p, "../", 3) == 0) {
707 /* We want to remove only one leading "../" prefix for
708 * the directory we couldn't create in dry-run mode:
709 * this ensures that any other ".." references get
710 * evaluated the same as they would for a live copy. */
711 *slash = '\0';
712 pathjoin(new, len, curr_dir, *dir_p + 3);
713 *slash = '/';
714 } else
715 pathjoin(new, len, curr_dir, *dir_p);
716 *dir_p = new;
717 }
718 if (do_stat(*dir_p, &st) < 0) {
719 rprintf(FWARNING, "%s arg does not exist: %s\n",
720 dest_option, *dir_p);
721 } else if (!S_ISDIR(st.st_mode)) {
722 rprintf(FWARNING, "%s arg is not a dir: %s\n",
723 dest_option, *dir_p);
724 }
725 }
726}
727
728/* This is only called by the sender. */
729static void read_final_goodbye(int f_in, int f_out)
730{
731 int i, iflags, xlen;
732 uchar fnamecmp_type;
733 char xname[MAXPATHLEN];
734
735 shutting_down = True;
736
737 if (protocol_version < 29)
738 i = read_int(f_in);
739 else {
740 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
741 if (protocol_version >= 31 && i == NDX_DONE) {
742 if (am_sender)
743 write_ndx(f_out, NDX_DONE);
744 else {
745 if (batch_gen_fd >= 0) {
746 while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
747 read_del_stats(batch_gen_fd);
748 }
749 write_int(f_out, NDX_DONE);
750 }
751 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
752 }
753 }
754
755 if (i != NDX_DONE) {
756 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
757 i, who_am_i());
758 exit_cleanup(RERR_PROTOCOL);
759 }
760}
761
762static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
763{
764 struct file_list *flist;
765 char *dir = argv[0];
766
767 if (DEBUG_GTE(SEND, 1)) {
768 rprintf(FINFO, "server_sender starting pid=%ld\n",
769 (long)getpid());
770 }
771
772 if (am_daemon && lp_write_only(module_id)) {
773 rprintf(FERROR, "ERROR: module is write only\n");
774 exit_cleanup(RERR_SYNTAX);
775 return;
776 }
777 if (am_daemon && read_only && remove_source_files) {
778 rprintf(FERROR,
779 "ERROR: --remove-%s-files cannot be used with a read-only module\n",
780 remove_source_files == 1 ? "source" : "sent");
781 exit_cleanup(RERR_SYNTAX);
782 return;
783 }
784
785 if (!relative_paths) {
786 if (!change_dir(dir, CD_NORMAL)) {
787 rsyserr(FERROR, errno, "change_dir#3 %s failed",
788 full_fname(dir));
789 exit_cleanup(RERR_FILESELECT);
790 }
791 }
792 argc--;
793 argv++;
794
795 if (argc == 0 && (recurse || xfer_dirs || list_only)) {
796 argc = 1;
797 argv--;
798 argv[0] = ".";
799 }
800
801 flist = send_file_list(f_out,argc,argv);
802 if (!flist || flist->used == 0)
803 exit_cleanup(0);
804
805 io_start_buffering_in(f_in);
806
807 send_files(f_in, f_out);
808 io_flush(FULL_FLUSH);
809 handle_stats(f_out);
810 if (protocol_version >= 24)
811 read_final_goodbye(f_in, f_out);
812 io_flush(FULL_FLUSH);
813 exit_cleanup(0);
814}
815
816
817static int do_recv(int f_in, int f_out, char *local_name)
818{
819 int pid;
820 int exit_code = 0;
821 int error_pipe[2];
822
823 /* The receiving side mustn't obey this, or an existing symlink that
824 * points to an identical file won't be replaced by the referent. */
825 copy_links = copy_dirlinks = copy_unsafe_links = 0;
826
827#ifdef SUPPORT_HARD_LINKS
828 if (preserve_hard_links && !inc_recurse)
829 match_hard_links(first_flist);
830#endif
831
832 if (fd_pair(error_pipe) < 0) {
833 rsyserr(FERROR, errno, "pipe failed in do_recv");
834 exit_cleanup(RERR_IPC);
835 }
836
837 if (backup_dir) {
838 int ret = make_path(backup_dir_buf, MKP_DROP_NAME); /* drops trailing slash */
839 if (ret < 0)
840 exit_cleanup(RERR_SYNTAX);
841 if (ret)
842 rprintf(FINFO, "Created backup_dir %s\n", backup_dir_buf);
843 else if (INFO_GTE(BACKUP, 1))
844 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
845 }
846
847 io_flush(FULL_FLUSH);
848
849 if ((pid = do_fork()) == -1) {
850 rsyserr(FERROR, errno, "fork failed in do_recv");
851 exit_cleanup(RERR_IPC);
852 }
853
854 if (pid == 0) {
855 am_receiver = 1;
856 send_msgs_to_gen = am_server;
857
858 close(error_pipe[0]);
859
860 /* We can't let two processes write to the socket at one time. */
861 io_end_multiplex_out(MPLX_SWITCHING);
862 if (f_in != f_out)
863 close(f_out);
864 sock_f_out = -1;
865 f_out = error_pipe[1];
866
867 bwlimit_writemax = 0; /* receiver doesn't need to do this */
868
869 if (read_batch)
870 io_start_buffering_in(f_in);
871 io_start_multiplex_out(f_out);
872
873 recv_files(f_in, f_out, local_name);
874 io_flush(FULL_FLUSH);
875 handle_stats(f_in);
876
877 if (output_needs_newline) {
878 fputc('\n', stdout);
879 output_needs_newline = 0;
880 }
881
882 write_int(f_out, NDX_DONE);
883 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
884 io_flush(FULL_FLUSH);
885
886 /* Handle any keep-alive packets from the post-processing work
887 * that the generator does. */
888 if (protocol_version >= 29) {
889 kluge_around_eof = -1;
890
891 /* This should only get stopped via a USR2 signal. */
892 read_final_goodbye(f_in, f_out);
893
894 rprintf(FERROR, "Invalid packet at end of run [%s]\n",
895 who_am_i());
896 exit_cleanup(RERR_PROTOCOL);
897 }
898
899 /* Finally, we go to sleep until our parent kills us with a
900 * USR2 signal. We sleep for a short time, as on some OSes
901 * a signal won't interrupt a sleep! */
902 while (1)
903 msleep(20);
904 }
905
906 am_generator = 1;
907 flist_receiving_enabled = True;
908
909 io_end_multiplex_in(MPLX_SWITCHING);
910 if (write_batch && !am_server)
911 stop_write_batch();
912
913 close(error_pipe[1]);
914 if (f_in != f_out)
915 close(f_in);
916 sock_f_in = -1;
917 f_in = error_pipe[0];
918
919 io_start_buffering_out(f_out);
920 io_start_multiplex_in(f_in);
921
922#ifdef SUPPORT_HARD_LINKS
923 if (preserve_hard_links && inc_recurse) {
924 struct file_list *flist;
925 for (flist = first_flist; flist; flist = flist->next)
926 match_hard_links(flist);
927 }
928#endif
929
930 generate_files(f_out, local_name);
931
932 handle_stats(-1);
933 io_flush(FULL_FLUSH);
934 shutting_down = True;
935 if (protocol_version >= 24) {
936 /* send a final goodbye message */
937 write_ndx(f_out, NDX_DONE);
938 }
939 io_flush(FULL_FLUSH);
940
941 kill(pid, SIGUSR2);
942 wait_process_with_flush(pid, &exit_code);
943 return exit_code;
944}
945
946static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
947{
948 int exit_code;
949 struct file_list *flist;
950 char *local_name = NULL;
951 int negated_levels;
952
953 if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
954 /* We can't mix messages with files-from data on the socket,
955 * so temporarily turn off info/debug messages. */
956 negate_output_levels();
957 negated_levels = 1;
958 } else
959 negated_levels = 0;
960
961 if (DEBUG_GTE(RECV, 1)) {
962 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
963 argc, (long)getpid());
964 }
965
966 if (am_daemon && read_only) {
967 rprintf(FERROR,"ERROR: module is read only\n");
968 exit_cleanup(RERR_SYNTAX);
969 return;
970 }
971
972 if (argc > 0) {
973 char *dir = argv[0];
974 argc--;
975 argv++;
976 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
977 rsyserr(FERROR, errno, "change_dir#4 %s failed",
978 full_fname(dir));
979 exit_cleanup(RERR_FILESELECT);
980 }
981 }
982
983 if (protocol_version >= 30)
984 io_start_multiplex_in(f_in);
985 else
986 io_start_buffering_in(f_in);
987 recv_filter_list(f_in);
988
989 if (filesfrom_fd >= 0) {
990 /* We need to send the files-from names to the sender at the
991 * same time that we receive the file-list from them, so we
992 * need the IO routines to automatically write out the names
993 * onto our f_out socket as we read the file-list. This
994 * avoids both deadlock and extra delays/buffers. */
995 start_filesfrom_forwarding(filesfrom_fd);
996 filesfrom_fd = -1;
997 }
998
999 flist = recv_file_list(f_in);
1000 if (!flist) {
1001 rprintf(FERROR,"server_recv: recv_file_list error\n");
1002 exit_cleanup(RERR_FILESELECT);
1003 }
1004 if (inc_recurse && file_total == 1)
1005 recv_additional_file_list(f_in);
1006
1007 if (negated_levels)
1008 negate_output_levels();
1009
1010 if (argc > 0)
1011 local_name = get_local_name(flist,argv[0]);
1012
1013 /* Now that we know what our destination directory turned out to be,
1014 * we can sanitize the --link-/copy-/compare-dest args correctly. */
1015 if (sanitize_paths) {
1016 char **dir_p;
1017 for (dir_p = basis_dir; *dir_p; dir_p++)
1018 *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1019 if (partial_dir)
1020 partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1021 }
1022 check_alt_basis_dirs();
1023
1024 if (daemon_filter_list.head) {
1025 char **dir_p;
1026 filter_rule_list *elp = &daemon_filter_list;
1027
1028 for (dir_p = basis_dir; *dir_p; dir_p++) {
1029 char *dir = *dir_p;
1030 if (*dir == '/')
1031 dir += module_dirlen;
1032 if (check_filter(elp, FLOG, dir, 1) < 0)
1033 goto options_rejected;
1034 }
1035 if (partial_dir && *partial_dir == '/'
1036 && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1037 options_rejected:
1038 rprintf(FERROR,
1039 "Your options have been rejected by the server.\n");
1040 exit_cleanup(RERR_SYNTAX);
1041 }
1042 }
1043
1044 exit_code = do_recv(f_in, f_out, local_name);
1045 exit_cleanup(exit_code);
1046}
1047
1048
1049int child_main(int argc, char *argv[])
1050{
1051 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1052 return 0;
1053}
1054
1055
1056void start_server(int f_in, int f_out, int argc, char *argv[])
1057{
1058 set_nonblocking(f_in);
1059 set_nonblocking(f_out);
1060
1061 io_set_sock_fds(f_in, f_out);
1062 setup_protocol(f_out, f_in);
1063
1064 if (protocol_version >= 23)
1065 io_start_multiplex_out(f_out);
1066 if (am_daemon && io_timeout && protocol_version >= 31)
1067 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1068
1069 if (am_sender) {
1070 keep_dirlinks = 0; /* Must be disabled on the sender. */
1071 if (need_messages_from_generator)
1072 io_start_multiplex_in(f_in);
1073 else
1074 io_start_buffering_in(f_in);
1075 recv_filter_list(f_in);
1076 do_server_sender(f_in, f_out, argc, argv);
1077 } else
1078 do_server_recv(f_in, f_out, argc, argv);
1079 exit_cleanup(0);
1080}
1081
1082/* This is called once the connection has been negotiated. It is used
1083 * for rsyncd, remote-shell, and local connections. */
1084int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1085{
1086 struct file_list *flist = NULL;
1087 int exit_code = 0, exit_code2 = 0;
1088 char *local_name = NULL;
1089
1090 cleanup_child_pid = pid;
1091 if (!read_batch) {
1092 set_nonblocking(f_in);
1093 set_nonblocking(f_out);
1094 }
1095
1096 io_set_sock_fds(f_in, f_out);
1097 setup_protocol(f_out,f_in);
1098
1099 /* We set our stderr file handle to blocking because ssh might have
1100 * set it to non-blocking. This can be particularly troublesome if
1101 * stderr is a clone of stdout, because ssh would have set our stdout
1102 * to non-blocking at the same time (which can easily cause us to lose
1103 * output from our print statements). This kluge shouldn't cause ssh
1104 * any problems for how we use it. Note also that we delayed setting
1105 * this until after the above protocol setup so that we know for sure
1106 * that ssh is done twiddling its file descriptors. */
1107 set_blocking(STDERR_FILENO);
1108
1109 if (am_sender) {
1110 keep_dirlinks = 0; /* Must be disabled on the sender. */
1111
1112 if (always_checksum
1113 && (log_format_has(stdout_format, 'C')
1114 || log_format_has(logfile_format, 'C')))
1115 sender_keeps_checksum = 1;
1116
1117 if (protocol_version >= 30)
1118 io_start_multiplex_out(f_out);
1119 else
1120 io_start_buffering_out(f_out);
1121 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1122 io_start_multiplex_in(f_in);
1123 else
1124 io_start_buffering_in(f_in);
1125 send_filter_list(f_out);
1126 if (filesfrom_host)
1127 filesfrom_fd = f_in;
1128
1129 if (write_batch && !am_server)
1130 start_write_batch(f_out);
1131 flist = send_file_list(f_out, argc, argv);
1132 if (DEBUG_GTE(FLIST, 3))
1133 rprintf(FINFO,"file list sent\n");
1134
1135 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1136 io_start_multiplex_in(f_in);
1137
1138 io_flush(NORMAL_FLUSH);
1139 send_files(f_in, f_out);
1140 io_flush(FULL_FLUSH);
1141 handle_stats(-1);
1142 if (protocol_version >= 24)
1143 read_final_goodbye(f_in, f_out);
1144 if (pid != -1) {
1145 if (DEBUG_GTE(EXIT, 2))
1146 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1147 io_flush(FULL_FLUSH);
1148 wait_process_with_flush(pid, &exit_code);
1149 }
1150 output_summary();
1151 io_flush(FULL_FLUSH);
1152 exit_cleanup(exit_code);
1153 }
1154
1155 if (!read_batch) {
1156 if (protocol_version >= 23)
1157 io_start_multiplex_in(f_in);
1158 if (need_messages_from_generator)
1159 io_start_multiplex_out(f_out);
1160 else
1161 io_start_buffering_out(f_out);
1162 }
1163
1164 send_filter_list(read_batch ? -1 : f_out);
1165
1166 if (filesfrom_fd >= 0) {
1167 start_filesfrom_forwarding(filesfrom_fd);
1168 filesfrom_fd = -1;
1169 }
1170
1171 if (write_batch && !am_server)
1172 start_write_batch(f_in);
1173 flist = recv_file_list(f_in);
1174 if (inc_recurse && file_total == 1)
1175 recv_additional_file_list(f_in);
1176
1177 if (flist && flist->used > 0) {
1178 local_name = get_local_name(flist, argv[0]);
1179
1180 check_alt_basis_dirs();
1181
1182 exit_code2 = do_recv(f_in, f_out, local_name);
1183 } else {
1184 handle_stats(-1);
1185 output_summary();
1186 }
1187
1188 if (pid != -1) {
1189 if (DEBUG_GTE(RECV, 1))
1190 rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1191 io_flush(FULL_FLUSH);
1192 wait_process_with_flush(pid, &exit_code);
1193 }
1194
1195 return MAX(exit_code, exit_code2);
1196}
1197
1198static int copy_argv(char *argv[])
1199{
1200 int i;
1201
1202 for (i = 0; argv[i]; i++) {
1203 if (!(argv[i] = strdup(argv[i]))) {
1204 rprintf (FERROR, "out of memory at %s(%d)\n",
1205 __FILE__, __LINE__);
1206 return RERR_MALLOC;
1207 }
1208 }
1209
1210 return 0;
1211}
1212
1213
1214/* Start a client for either type of remote connection. Work out
1215 * whether the arguments request a remote shell or rsyncd connection,
1216 * and call the appropriate connection function, then run_client.
1217 *
1218 * Calls either start_socket_client (for sockets) or do_cmd and
1219 * client_run (for ssh). */
1220static int start_client(int argc, char *argv[])
1221{
1222 char *p, *shell_machine = NULL, *shell_user = NULL;
1223 char **remote_argv;
1224 int remote_argc;
1225 int f_in, f_out;
1226 int ret;
1227 pid_t pid;
1228
1229 /* Don't clobber argv[] so that ps(1) can still show the right
1230 * command line. */
1231 if ((ret = copy_argv(argv)) != 0)
1232 return ret;
1233
1234 if (!read_batch) { /* for read_batch, NO source is specified */
1235 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1236 if (path) { /* source is remote */
1237 char *dummy_host;
1238 int dummy_port = 0;
1239 *argv = path;
1240 remote_argv = argv;
1241 remote_argc = argc;
1242 argv += argc - 1;
1243 if (argc == 1 || **argv == ':')
1244 argc = 0; /* no dest arg */
1245 else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1246 rprintf(FERROR,
1247 "The source and destination cannot both be remote.\n");
1248 exit_cleanup(RERR_SYNTAX);
1249 } else {
1250 remote_argc--; /* don't count dest */
1251 argc = 1;
1252 }
1253 if (filesfrom_host && *filesfrom_host
1254 && strcmp(filesfrom_host, shell_machine) != 0) {
1255 rprintf(FERROR,
1256 "--files-from hostname is not the same as the transfer hostname\n");
1257 exit_cleanup(RERR_SYNTAX);
1258 }
1259 am_sender = 0;
1260 if (rsync_port)
1261 daemon_over_rsh = shell_cmd ? 1 : -1;
1262 } else { /* source is local, check dest arg */
1263 am_sender = 1;
1264
1265 if (argc > 1) {
1266 p = argv[--argc];
1267 remote_argv = argv + argc;
1268 } else {
1269 static char *dotarg[1] = { "." };
1270 p = dotarg[0];
1271 remote_argv = dotarg;
1272 }
1273 remote_argc = 1;
1274
1275 path = check_for_hostspec(p, &shell_machine, &rsync_port);
1276 if (path && filesfrom_host && *filesfrom_host
1277 && strcmp(filesfrom_host, shell_machine) != 0) {
1278 rprintf(FERROR,
1279 "--files-from hostname is not the same as the transfer hostname\n");
1280 exit_cleanup(RERR_SYNTAX);
1281 }
1282 if (!path) { /* no hostspec found, so src & dest are local */
1283 local_server = 1;
1284 if (filesfrom_host) {
1285 rprintf(FERROR,
1286 "--files-from cannot be remote when the transfer is local\n");
1287 exit_cleanup(RERR_SYNTAX);
1288 }
1289 shell_machine = NULL;
1290 } else { /* hostspec was found, so dest is remote */
1291 argv[argc] = path;
1292 if (rsync_port)
1293 daemon_over_rsh = shell_cmd ? 1 : -1;
1294 }
1295 }
1296 } else { /* read_batch */
1297 local_server = 1;
1298 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1299 rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1300 exit_cleanup(RERR_SYNTAX);
1301 }
1302 remote_argv = argv += argc - 1;
1303 remote_argc = argc = 1;
1304 }
1305
1306 if (am_sender) {
1307 char *dummy_host;
1308 int dummy_port = rsync_port;
1309 int i;
1310 /* For local source, extra source args must not have hostspec. */
1311 for (i = 1; i < argc; i++) {
1312 if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1313 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1314 exit_cleanup(RERR_SYNTAX);
1315 }
1316 }
1317 } else {
1318 char *dummy_host;
1319 int dummy_port = rsync_port;
1320 int i;
1321 /* For remote source, any extra source args must have either
1322 * the same hostname or an empty hostname. */
1323 for (i = 1; i < remote_argc; i++) {
1324 char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1325 if (!arg) {
1326 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1327 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1328 exit_cleanup(RERR_SYNTAX);
1329 }
1330 if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1331 rprintf(FERROR, "All source args must come from the same machine.\n");
1332 exit_cleanup(RERR_SYNTAX);
1333 }
1334 if (rsync_port != dummy_port) {
1335 if (!rsync_port || !dummy_port)
1336 rprintf(FERROR, "All source args must use the same hostspec format.\n");
1337 else
1338 rprintf(FERROR, "All source args must use the same port number.\n");
1339 exit_cleanup(RERR_SYNTAX);
1340 }
1341 remote_argv[i] = arg;
1342 }
1343 }
1344
1345 if (daemon_over_rsh < 0)
1346 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1347
1348 if (password_file && !daemon_over_rsh) {
1349 rprintf(FERROR, "The --password-file option may only be "
1350 "used when accessing an rsync daemon.\n");
1351 exit_cleanup(RERR_SYNTAX);
1352 }
1353
1354 if (connect_timeout) {
1355 rprintf(FERROR, "The --contimeout option may only be "
1356 "used when connecting to an rsync daemon.\n");
1357 exit_cleanup(RERR_SYNTAX);
1358 }
1359
1360 if (shell_machine) {
1361 p = strrchr(shell_machine,'@');
1362 if (p) {
1363 *p = 0;
1364 shell_user = shell_machine;
1365 shell_machine = p+1;
1366 }
1367 }
1368
1369 if (DEBUG_GTE(CMD, 2)) {
1370 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1371 NS(shell_cmd), NS(shell_machine), NS(shell_user),
1372 NS(remote_argv[0]));
1373 }
1374
1375 pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1376 &f_in, &f_out);
1377
1378 /* if we're running an rsync server on the remote host over a
1379 * remote shell command, we need to do the RSYNCD protocol first */
1380 if (daemon_over_rsh) {
1381 int tmpret;
1382 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1383 if (tmpret < 0)
1384 return tmpret;
1385 }
1386
1387 ret = client_run(f_in, f_out, pid, argc, argv);
1388
1389 fflush(stdout);
1390 fflush(stderr);
1391
1392 return ret;
1393}
1394
1395
1396static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1397{
1398 exit_cleanup(RERR_SIGNAL1);
1399}
1400
1401static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1402{
1403 if (!am_server)
1404 output_summary();
1405 close_all();
1406 if (got_xfer_error)
1407 _exit(RERR_PARTIAL);
1408 _exit(0);
1409}
1410
1411RETSIGTYPE remember_children(UNUSED(int val))
1412{
1413#ifdef WNOHANG
1414 int cnt, status;
1415 pid_t pid;
1416 /* An empty waitpid() loop was put here by Tridge and we could never
1417 * get him to explain why he put it in, so rather than taking it
1418 * out we're instead saving the child exit statuses for later use.
1419 * The waitpid() loop presumably eliminates all possibility of leaving
1420 * zombie children, maybe that's why he did it. */
1421 while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1422 /* save the child's exit status */
1423 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1424 if (pid_stat_table[cnt].pid == 0) {
1425 pid_stat_table[cnt].pid = pid;
1426 pid_stat_table[cnt].status = status;
1427 break;
1428 }
1429 }
1430 }
1431#endif
1432#ifndef HAVE_SIGACTION
1433 signal(SIGCHLD, remember_children);
1434#endif
1435}
1436
1437
1438/**
1439 * This routine catches signals and tries to send them to gdb.
1440 *
1441 * Because it's called from inside a signal handler it ought not to
1442 * use too many library routines.
1443 *
1444 * @todo Perhaps use "screen -X" instead/as well, to help people
1445 * debugging without easy access to X. Perhaps use an environment
1446 * variable, or just call a script?
1447 *
1448 * @todo The /proc/ magic probably only works on Linux (and
1449 * Solaris?) Can we be more portable?
1450 **/
1451#ifdef MAINTAINER_MODE
1452const char *get_panic_action(void)
1453{
1454 const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1455
1456 if (cmd_fmt)
1457 return cmd_fmt;
1458 else
1459 return "xterm -display :0 -T Panic -n Panic "
1460 "-e gdb /proc/%d/exe %d";
1461}
1462
1463
1464/**
1465 * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1466 *
1467 * This signal handler is only installed if we were configured with
1468 * --enable-maintainer-mode. Perhaps it should always be on and we
1469 * should just look at the environment variable, but I'm a bit leery
1470 * of a signal sending us into a busy loop.
1471 **/
1472static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1473{
1474 char cmd_buf[300];
1475 int ret;
1476
1477 snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(),
1478 getpid(), getpid());
1479
1480 /* Unless we failed to execute gdb, we allow the process to
1481 * continue. I'm not sure if that's right. */
1482 ret = system(cmd_buf);
1483 if (ret)
1484 _exit(ret);
1485}
1486#endif
1487
1488
1489int main(int argc,char *argv[])
1490{
1491 int ret;
1492 int orig_argc = argc;
1493 char **orig_argv = argv;
1494#ifdef HAVE_SIGACTION
1495# ifdef HAVE_SIGPROCMASK
1496 sigset_t sigmask;
1497
1498 sigemptyset(&sigmask);
1499# endif
1500 sigact.sa_flags = SA_NOCLDSTOP;
1501#endif
1502 SIGACTMASK(SIGUSR1, sigusr1_handler);
1503 SIGACTMASK(SIGUSR2, sigusr2_handler);
1504 SIGACTMASK(SIGCHLD, remember_children);
1505#ifdef MAINTAINER_MODE
1506 SIGACTMASK(SIGSEGV, rsync_panic_handler);
1507 SIGACTMASK(SIGFPE, rsync_panic_handler);
1508 SIGACTMASK(SIGABRT, rsync_panic_handler);
1509 SIGACTMASK(SIGBUS, rsync_panic_handler);
1510#endif
1511
1512 starttime = time(NULL);
1513 our_uid = MY_UID();
1514 our_gid = MY_GID();
1515 am_root = our_uid == 0;
1516
1517 memset(&stats, 0, sizeof(stats));
1518
1519 if (argc < 2) {
1520 usage(FERROR);
1521 exit_cleanup(RERR_SYNTAX);
1522 }
1523
1524 /* we set a 0 umask so that correct file permissions can be
1525 * carried across */
1526 orig_umask = umask(0);
1527
1528#if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1529 setlocale(LC_CTYPE, "");
1530#endif
1531
1532 if (!parse_arguments(&argc, (const char ***) &argv)) {
1533 /* FIXME: We ought to call the same error-handling
1534 * code here, rather than relying on getopt. */
1535 option_error();
1536 exit_cleanup(RERR_SYNTAX);
1537 }
1538
1539 SIGACTMASK(SIGINT, sig_int);
1540 SIGACTMASK(SIGHUP, sig_int);
1541 SIGACTMASK(SIGTERM, sig_int);
1542#if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1543 sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1544#endif
1545
1546 /* Ignore SIGPIPE; we consistently check error codes and will
1547 * see the EPIPE. */
1548 SIGACTION(SIGPIPE, SIG_IGN);
1549#ifdef SIGXFSZ
1550 SIGACTION(SIGXFSZ, SIG_IGN);
1551#endif
1552
1553 /* Initialize change_dir() here because on some old systems getcwd
1554 * (implemented by forking "pwd" and reading its output) doesn't
1555 * work when there are other child processes. Also, on all systems
1556 * that implement getcwd that way "pwd" can't be found after chroot. */
1557 change_dir(NULL, CD_NORMAL);
1558
1559 init_flist();
1560
1561 if ((write_batch || read_batch) && !am_server) {
1562 if (write_batch)
1563 write_batch_shell_file(orig_argc, orig_argv, argc);
1564
1565 if (read_batch && strcmp(batch_name, "-") == 0)
1566 batch_fd = STDIN_FILENO;
1567 else {
1568 batch_fd = do_open(batch_name,
1569 write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1570 : O_RDONLY, S_IRUSR | S_IWUSR);
1571 }
1572 if (batch_fd < 0) {
1573 rsyserr(FERROR, errno, "Batch file %s open error",
1574 full_fname(batch_name));
1575 exit_cleanup(RERR_FILEIO);
1576 }
1577 if (read_batch)
1578 read_stream_flags(batch_fd);
1579 else
1580 write_stream_flags(batch_fd);
1581 }
1582 if (write_batch < 0)
1583 dry_run = 1;
1584
1585 if (am_server) {
1586#ifdef ICONV_CONST
1587 setup_iconv();
1588#endif
1589 } else if (am_daemon)
1590 return daemon_main();
1591
1592 if (am_server && protect_args) {
1593 char buf[MAXPATHLEN];
1594 protect_args = 2;
1595 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1596 if (!parse_arguments(&argc, (const char ***) &argv)) {
1597 option_error();
1598 exit_cleanup(RERR_SYNTAX);
1599 }
1600 }
1601
1602 if (argc < 1) {
1603 usage(FERROR);
1604 exit_cleanup(RERR_SYNTAX);
1605 }
1606
1607 if (am_server) {
1608 set_nonblocking(STDIN_FILENO);
1609 set_nonblocking(STDOUT_FILENO);
1610 if (am_daemon)
1611 return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1612 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1613 }
1614
1615 ret = start_client(argc, argv);
1616 if (ret == -1)
1617 exit_cleanup(RERR_STARTCLIENT);
1618 else
1619 exit_cleanup(ret);
1620
1621 return ret;
1622}