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