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