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