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