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