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