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