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