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