Changed rprintf() messages that started with a newline into two
[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 and return
459  * either a NULL for mode 1, or the local-name for mode 2.  We also
460  * change directory if there are any path components in dest_path. */
461 static char *get_local_name(struct file_list *flist, char *dest_path)
462 {
463         STRUCT_STAT st;
464         char *cp;
465
466         if (verbose > 2) {
467                 rprintf(FINFO, "get_local_name count=%d %s\n",
468                         flist->count, NS(dest_path));
469         }
470
471         if (!dest_path || list_only)
472                 return NULL;
473
474         /* If the destination path refers to an existing directory, enter
475          * it and use mode 1.  If there is something other than a directory
476          * at the destination path, we must be transferring one file
477          * (anything at the destination will be overwritten). */
478         if (safe_stat(dest_path, &st) == 0) {
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                 rsyserr(FERROR, errno, "cannot stat destination %s",
506                         full_fname(dest_path));
507                 exit_cleanup(RERR_FILESELECT);
508         }
509
510         cp = strrchr(dest_path, '/');
511
512         /* If the destination path ends in a slash or we are transferring
513          * multiple files, create a directory at the destination path,
514          * enter the new directory, and use mode 1. */
515         if (flist->count > 1 || (cp && !cp[1])) {
516                 /* Lop off the final slash (if any). */
517                 if (cp && !cp[1])
518                         *cp = '\0';
519
520                 if (mkdir_defmode(dest_path) != 0) {
521                         rsyserr(FERROR, errno, "mkdir %s failed",
522                                 full_fname(dest_path));
523                         exit_cleanup(RERR_FILEIO);
524                 }
525
526                 if (verbose)
527                         rprintf(FINFO, "created directory %s\n", dest_path);
528
529                 if (dry_run) {
530                         /* Indicate that the destination directory doesn't
531                          * really exist and return mode 1. */
532                         dry_run++;
533                         return NULL;
534                 }
535
536                 if (sanitize_paths)
537                         die_on_unsafe_path(dest_path, 0);
538                 if (!push_dir(dest_path)) {
539                         rsyserr(FERROR, errno, "push_dir#2 %s failed",
540                                 full_fname(dest_path));
541                         exit_cleanup(RERR_FILESELECT);
542                 }
543
544                 return NULL;
545         }
546
547         /* Otherwise, we are writing a single file, possibly on top of an
548          * existing non-directory.  Change to the item's parent directory
549          * (if it has a path component), return the basename of the
550          * destination file as the local name, and use mode 2. */
551         if (!cp)
552                 return dest_path;
553
554         if (cp == dest_path)
555                 dest_path = "/";
556
557         *cp = '\0';
558         if (sanitize_paths)
559                 die_on_unsafe_path(dest_path, 0);
560         if (!push_dir(dest_path)) {
561                 rsyserr(FERROR, errno, "push_dir#3 %s failed",
562                         full_fname(dest_path));
563                 exit_cleanup(RERR_FILESELECT);
564         }
565         *cp = '/';
566
567         return cp + 1;
568 }
569
570
571 /* This is only called by the sender. */
572 static void read_final_goodbye(int f_in, int f_out)
573 {
574         int i;
575
576         if (protocol_version < 29)
577                 i = read_int(f_in);
578         else {
579                 while ((i = read_int(f_in)) == the_file_list->count
580                     && read_shortint(f_in) == ITEM_IS_NEW) {
581                         /* Forward the keep-alive (no-op) to the receiver. */
582                         write_int(f_out, the_file_list->count);
583                         write_shortint(f_out, ITEM_IS_NEW);
584                 }
585         }
586
587         if (i != -1) {
588                 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
589                         i, who_am_i());
590                 exit_cleanup(RERR_PROTOCOL);
591         }
592 }
593
594
595 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
596 {
597         struct file_list *flist;
598         char *dir = argv[0];
599
600         if (verbose > 2) {
601                 rprintf(FINFO, "server_sender starting pid=%ld\n",
602                         (long)getpid());
603         }
604
605         if (am_daemon && lp_write_only(module_id)) {
606                 rprintf(FERROR, "ERROR: module is write only\n");
607                 exit_cleanup(RERR_SYNTAX);
608                 return;
609         }
610         if (am_daemon && lp_read_only(module_id) && remove_sent_files) {
611                 rprintf(FERROR,
612                     "ERROR: --remove-sent-files cannot be used with a read-only module\n");
613                 exit_cleanup(RERR_SYNTAX);
614                 return;
615         }
616
617         if (!relative_paths) {
618                 if (sanitize_paths)
619                         die_on_unsafe_path(dir, 0);
620                 if (!push_dir(dir)) {
621                         rsyserr(FERROR, errno, "push_dir#3 %s failed",
622                                 full_fname(dir));
623                         exit_cleanup(RERR_FILESELECT);
624                 }
625         }
626         argc--;
627         argv++;
628
629         if (argc == 0 && (recurse || list_only)) {
630                 argc = 1;
631                 argv--;
632                 argv[0] = ".";
633         }
634
635         flist = send_file_list(f_out,argc,argv);
636         if (!flist || flist->count == 0) {
637                 exit_cleanup(0);
638         }
639         the_file_list = flist;
640
641         io_start_buffering_in();
642         io_start_buffering_out();
643
644         send_files(flist,f_out,f_in);
645         io_flush(FULL_FLUSH);
646         handle_stats(f_out);
647         if (protocol_version >= 24)
648                 read_final_goodbye(f_in, f_out);
649         io_flush(FULL_FLUSH);
650         exit_cleanup(0);
651 }
652
653
654 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
655 {
656         int pid;
657         int exit_code = 0;
658         int error_pipe[2];
659
660         /* The receiving side mustn't obey this, or an existing symlink that
661          * points to an identical file won't be replaced by the referent. */
662         copy_links = copy_dirlinks = 0;
663
664         if (preserve_hard_links)
665                 init_hard_links();
666
667         if (fd_pair(error_pipe) < 0) {
668                 rsyserr(FERROR, errno, "pipe failed in do_recv");
669                 exit_cleanup(RERR_IPC);
670         }
671
672         io_flush(NORMAL_FLUSH);
673
674         if ((pid = do_fork()) == -1) {
675                 rsyserr(FERROR, errno, "fork failed in do_recv");
676                 exit_cleanup(RERR_IPC);
677         }
678
679         if (pid == 0) {
680                 close(error_pipe[0]);
681                 if (f_in != f_out)
682                         close(f_out);
683
684                 /* we can't let two processes write to the socket at one time */
685                 close_multiplexing_out();
686
687                 /* set place to send errors */
688                 set_msg_fd_out(error_pipe[1]);
689
690                 recv_files(f_in, flist, local_name);
691                 io_flush(FULL_FLUSH);
692                 handle_stats(f_in);
693
694                 send_msg(MSG_DONE, "", 0);
695                 io_flush(FULL_FLUSH);
696
697                 /* Handle any keep-alive packets from the post-processing work
698                  * that the generator does. */
699                 if (protocol_version >= 29) {
700                         kluge_around_eof = -1;
701
702                         /* This should only get stopped via a USR2 signal. */
703                         while (read_int(f_in) == flist->count
704                             && read_shortint(f_in) == ITEM_IS_NEW) {}
705
706                         rprintf(FERROR, "Invalid packet at end of run [%s]\n",
707                                 who_am_i());
708                         exit_cleanup(RERR_PROTOCOL);
709                 }
710
711                 /* Finally, we go to sleep until our parent kills us with a
712                  * USR2 signal.  We sleep for a short time, as on some OSes
713                  * a signal won't interrupt a sleep! */
714                 while (1)
715                         msleep(20);
716         }
717
718         am_generator = 1;
719         close_multiplexing_in();
720         if (write_batch && !am_server)
721                 stop_write_batch();
722
723         close(error_pipe[1]);
724         if (f_in != f_out)
725                 close(f_in);
726
727         io_start_buffering_out();
728
729         set_msg_fd_in(error_pipe[0]);
730
731         generate_files(f_out, flist, local_name);
732
733         handle_stats(-1);
734         io_flush(FULL_FLUSH);
735         if (protocol_version >= 24) {
736                 /* send a final goodbye message */
737                 write_int(f_out, -1);
738         }
739         io_flush(FULL_FLUSH);
740
741         set_msg_fd_in(-1);
742         kill(pid, SIGUSR2);
743         wait_process_with_flush(pid, &exit_code);
744         return exit_code;
745 }
746
747
748 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
749 {
750         int exit_code;
751         struct file_list *flist;
752         char *local_name = NULL;
753         char *dir = NULL;
754         int save_verbose = verbose;
755
756         if (filesfrom_fd >= 0) {
757                 /* We can't mix messages with files-from data on the socket,
758                  * so temporarily turn off verbose messages. */
759                 verbose = 0;
760         }
761
762         if (verbose > 2) {
763                 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
764                         argc, (long)getpid());
765         }
766
767         if (am_daemon && lp_read_only(module_id)) {
768                 rprintf(FERROR,"ERROR: module is read only\n");
769                 exit_cleanup(RERR_SYNTAX);
770                 return;
771         }
772
773         if (argc > 0) {
774                 dir = argv[0];
775                 argc--;
776                 argv++;
777                 if (!am_daemon && !push_dir(dir)) {
778                         rsyserr(FERROR, errno, "push_dir#4 %s failed",
779                                 full_fname(dir));
780                         exit_cleanup(RERR_FILESELECT);
781                 }
782         }
783
784         io_start_buffering_in();
785         recv_filter_list(f_in);
786
787         if (filesfrom_fd >= 0) {
788                 /* We need to send the files-from names to the sender at the
789                  * same time that we receive the file-list from them, so we
790                  * need the IO routines to automatically write out the names
791                  * onto our f_out socket as we read the file-list.  This
792                  * avoids both deadlock and extra delays/buffers. */
793                 io_set_filesfrom_fds(filesfrom_fd, f_out);
794                 filesfrom_fd = -1;
795         }
796
797         flist = recv_file_list(f_in);
798         verbose = save_verbose;
799         if (!flist) {
800                 rprintf(FERROR,"server_recv: recv_file_list error\n");
801                 exit_cleanup(RERR_FILESELECT);
802         }
803         the_file_list = flist;
804
805         if (argc > 0)
806                 local_name = get_local_name(flist,argv[0]);
807
808         /* Now that we know what our destination directory turned out to be,
809          * we can sanitize the --link-/copy-/compare-dest args correctly. */
810         if (sanitize_paths) {
811                 char **dir;
812                 for (dir = basis_dir; *dir; dir++) {
813                         *dir = sanitize_path(NULL, *dir, NULL, curr_dir_depth, NULL);
814                         die_on_unsafe_path(*dir, 0);
815                 }
816                 if (partial_dir) {
817                         partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, NULL);
818                         /* A relative path gets this checked at every dir change. */
819                         if (*partial_dir == '/')
820                                 die_on_unsafe_path(partial_dir, 0);
821                 }
822         }
823         if (server_filter_list.head) {
824                 char **dir;
825                 struct filter_list_struct *elp = &server_filter_list;
826
827                 for (dir = basis_dir; *dir; dir++) {
828                         if (check_filter(elp, *dir, 1) < 0)
829                                 goto options_rejected;
830                 }
831                 if (partial_dir && *partial_dir == '/'
832                  && check_filter(elp, partial_dir, 1) < 0) {
833                     options_rejected:
834                         rprintf(FERROR,
835                                 "Your options have been rejected by the server.\n");
836                         exit_cleanup(RERR_SYNTAX);
837                 }
838         }
839
840         exit_code = do_recv(f_in,f_out,flist,local_name);
841         exit_cleanup(exit_code);
842 }
843
844
845 int child_main(int argc, char *argv[])
846 {
847         start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
848         return 0;
849 }
850
851
852 void start_server(int f_in, int f_out, int argc, char *argv[])
853 {
854         set_nonblocking(f_in);
855         set_nonblocking(f_out);
856
857         io_set_sock_fds(f_in, f_out);
858         setup_protocol(f_out, f_in);
859 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
860         setup_iconv();
861 #endif
862
863         if (protocol_version >= 23)
864                 io_start_multiplex_out();
865
866         if (am_sender) {
867                 keep_dirlinks = 0; /* Must be disabled on the sender. */
868                 if (need_messages_from_generator)
869                         io_start_multiplex_in();
870
871                 recv_filter_list(f_in);
872                 do_server_sender(f_in, f_out, argc, argv);
873         } else {
874                 do_server_recv(f_in, f_out, argc, argv);
875         }
876         exit_cleanup(0);
877 }
878
879
880 /*
881  * This is called once the connection has been negotiated.  It is used
882  * for rsyncd, remote-shell, and local connections.
883  */
884 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
885 {
886         struct file_list *flist = NULL;
887         int exit_code = 0, exit_code2 = 0;
888         char *local_name = NULL;
889
890         cleanup_child_pid = pid;
891         if (!read_batch) {
892                 set_nonblocking(f_in);
893                 set_nonblocking(f_out);
894         }
895
896         io_set_sock_fds(f_in, f_out);
897         setup_protocol(f_out,f_in);
898 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
899         setup_iconv();
900 #endif
901
902         if (protocol_version >= 23 && !read_batch)
903                 io_start_multiplex_in();
904
905         /* We set our stderr file handle to blocking because ssh might have
906          * set it to non-blocking.  This can be particularly troublesome if
907          * stderr is a clone of stdout, because ssh would have set our stdout
908          * to non-blocking at the same time (which can easily cause us to lose
909          * output from our print statements).  This kluge shouldn't cause ssh
910          * any problems for how we use it.  Note also that we delayed setting
911          * this until after the above protocol setup so that we know for sure
912          * that ssh is done twiddling its file descriptors.  */
913         set_blocking(STDERR_FILENO);
914
915         if (am_sender) {
916                 keep_dirlinks = 0; /* Must be disabled on the sender. */
917                 io_start_buffering_out();
918                 if (!filesfrom_host)
919                         set_msg_fd_in(f_in);
920                 send_filter_list(f_out);
921                 if (filesfrom_host)
922                         filesfrom_fd = f_in;
923
924                 if (write_batch && !am_server)
925                         start_write_batch(f_out);
926                 flist = send_file_list(f_out, argc, argv);
927                 set_msg_fd_in(-1);
928                 if (verbose > 3)
929                         rprintf(FINFO,"file list sent\n");
930                 the_file_list = flist;
931
932                 io_flush(NORMAL_FLUSH);
933                 send_files(flist,f_out,f_in);
934                 io_flush(FULL_FLUSH);
935                 handle_stats(-1);
936                 if (protocol_version >= 24)
937                         read_final_goodbye(f_in, f_out);
938                 if (pid != -1) {
939                         if (verbose > 3)
940                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
941                         io_flush(FULL_FLUSH);
942                         wait_process_with_flush(pid, &exit_code);
943                 }
944                 output_summary();
945                 io_flush(FULL_FLUSH);
946                 exit_cleanup(exit_code);
947         }
948
949         if (need_messages_from_generator && !read_batch)
950                 io_start_multiplex_out();
951
952         if (argc == 0)
953                 list_only |= 1;
954
955         send_filter_list(read_batch ? -1 : f_out);
956
957         if (filesfrom_fd >= 0) {
958                 io_set_filesfrom_fds(filesfrom_fd, f_out);
959                 filesfrom_fd = -1;
960         }
961
962         if (write_batch && !am_server)
963                 start_write_batch(f_in);
964         flist = recv_file_list(f_in);
965         the_file_list = flist;
966
967         if (flist && flist->count > 0) {
968                 local_name = get_local_name(flist, argv[0]);
969
970                 exit_code2 = do_recv(f_in, f_out, flist, local_name);
971         } else {
972                 handle_stats(-1);
973                 output_summary();
974         }
975
976         if (pid != -1) {
977                 if (verbose > 3)
978                         rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
979                 io_flush(FULL_FLUSH);
980                 wait_process_with_flush(pid, &exit_code);
981         }
982
983         return MAX(exit_code, exit_code2);
984 }
985
986 static int copy_argv (char *argv[])
987 {
988         int i;
989
990         for (i = 0; argv[i]; i++) {
991                 if (!(argv[i] = strdup(argv[i]))) {
992                         rprintf (FERROR, "out of memory at %s(%d)\n",
993                                  __FILE__, __LINE__);
994                         return RERR_MALLOC;
995                 }
996         }
997
998         return 0;
999 }
1000
1001
1002 /**
1003  * Start a client for either type of remote connection.  Work out
1004  * whether the arguments request a remote shell or rsyncd connection,
1005  * and call the appropriate connection function, then run_client.
1006  *
1007  * Calls either start_socket_client (for sockets) or do_cmd and
1008  * client_run (for ssh).
1009  **/
1010 static int start_client(int argc, char *argv[])
1011 {
1012         char *p;
1013         char *shell_machine = NULL;
1014         char *shell_path = NULL;
1015         char *shell_user = NULL;
1016         int ret;
1017         pid_t pid;
1018         int f_in,f_out;
1019         int rc;
1020
1021         /* Don't clobber argv[] so that ps(1) can still show the right
1022          * command line. */
1023         if ((rc = copy_argv(argv)))
1024                 return rc;
1025
1026         if (!read_batch) { /* for read_batch, NO source is specified */
1027                 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1028                 if (shell_path) { /* source is remote */
1029                         char *dummy1;
1030                         int dummy2;
1031                         if (--argc
1032                          && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
1033                                 rprintf(FERROR,
1034                                         "The source and destination cannot both be remote.\n");
1035                                 exit_cleanup(RERR_SYNTAX);
1036                         }
1037                         argv++;
1038                         if (filesfrom_host && *filesfrom_host
1039                             && strcmp(filesfrom_host, shell_machine) != 0) {
1040                                 rprintf(FERROR,
1041                                         "--files-from hostname is not the same as the transfer hostname\n");
1042                                 exit_cleanup(RERR_SYNTAX);
1043                         }
1044                         if (rsync_port) {
1045                                 if (!shell_cmd) {
1046                                         return start_socket_client(shell_machine,
1047                                                                    shell_path,
1048                                                                    argc, argv);
1049                                 }
1050                                 daemon_over_rsh = 1;
1051                         }
1052
1053                         am_sender = 0;
1054                 } else { /* source is local, check dest arg */
1055                         am_sender = 1;
1056
1057                         if (argc > 1)
1058                                 p = argv[--argc];
1059                         else {
1060                                 p = ".";
1061                                 list_only = 1;
1062                         }
1063
1064                         shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1065                         if (shell_path && filesfrom_host && *filesfrom_host
1066                             && strcmp(filesfrom_host, shell_machine) != 0) {
1067                                 rprintf(FERROR,
1068                                         "--files-from hostname is not the same as the transfer hostname\n");
1069                                 exit_cleanup(RERR_SYNTAX);
1070                         }
1071                         if (!shell_path) { /* no hostspec found, so src & dest are local */
1072                                 local_server = 1;
1073                                 if (filesfrom_host) {
1074                                         rprintf(FERROR,
1075                                                 "--files-from cannot be remote when the transfer is local\n");
1076                                         exit_cleanup(RERR_SYNTAX);
1077                                 }
1078                                 shell_machine = NULL;
1079                                 shell_path = p;
1080                         } else if (rsync_port) {
1081                                 if (!shell_cmd) {
1082                                         return start_socket_client(shell_machine,
1083                                                                    shell_path,
1084                                                                    argc, argv);
1085                                 }
1086                                 daemon_over_rsh = 1;
1087                         }
1088                 }
1089         } else {  /* read_batch */
1090                 local_server = 1;
1091                 shell_path = argv[argc-1];
1092                 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1093                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1094                         exit_cleanup(RERR_SYNTAX);
1095                 }
1096         }
1097
1098         if (shell_machine) {
1099                 p = strrchr(shell_machine,'@');
1100                 if (p) {
1101                         *p = 0;
1102                         shell_user = shell_machine;
1103                         shell_machine = p+1;
1104                 }
1105         }
1106
1107         if (verbose > 3) {
1108                 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1109                         shell_cmd ? shell_cmd : "",
1110                         shell_machine ? shell_machine : "",
1111                         shell_user ? shell_user : "",
1112                         shell_path ? shell_path : "");
1113         }
1114
1115         /* for remote source, only single dest arg can remain ... */
1116         if (!am_sender && argc > 1) {
1117                 usage(FERROR);
1118                 exit_cleanup(RERR_SYNTAX);
1119         }
1120
1121         /* ... or no dest at all */
1122         if (!am_sender && argc == 0)
1123                 list_only |= 1;
1124
1125         pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1126                      &f_in,&f_out);
1127
1128         /* if we're running an rsync server on the remote host over a
1129          * remote shell command, we need to do the RSYNCD protocol first */
1130         if (daemon_over_rsh) {
1131                 int tmpret;
1132                 tmpret = start_inband_exchange(shell_user, shell_path,
1133                                                f_in, f_out, argc);
1134                 if (tmpret < 0)
1135                         return tmpret;
1136         }
1137
1138         ret = client_run(f_in, f_out, pid, argc, argv);
1139
1140         fflush(stdout);
1141         fflush(stderr);
1142
1143         return ret;
1144 }
1145
1146
1147 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1148 {
1149         exit_cleanup(RERR_SIGNAL1);
1150 }
1151
1152 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1153 {
1154         if (!am_server)
1155                 output_summary();
1156         close_all();
1157         if (log_got_error)
1158                 _exit(RERR_PARTIAL);
1159         _exit(0);
1160 }
1161
1162 RETSIGTYPE remember_children(UNUSED(int val))
1163 {
1164 #ifdef WNOHANG
1165         int cnt, status;
1166         pid_t pid;
1167         /* An empty waitpid() loop was put here by Tridge and we could never
1168          * get him to explain why he put it in, so rather than taking it
1169          * out we're instead saving the child exit statuses for later use.
1170          * The waitpid() loop presumably eliminates all possibility of leaving
1171          * zombie children, maybe that's why he did it. */
1172         while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1173                 /* save the child's exit status */
1174                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1175                         if (pid_stat_table[cnt].pid == 0) {
1176                                 pid_stat_table[cnt].pid = pid;
1177                                 pid_stat_table[cnt].status = status;
1178                                 break;
1179                         }
1180                 }
1181         }
1182 #endif
1183 #ifndef HAVE_SIGACTION
1184         signal(SIGCHLD, remember_children);
1185 #endif
1186 }
1187
1188
1189 /**
1190  * This routine catches signals and tries to send them to gdb.
1191  *
1192  * Because it's called from inside a signal handler it ought not to
1193  * use too many library routines.
1194  *
1195  * @todo Perhaps use "screen -X" instead/as well, to help people
1196  * debugging without easy access to X.  Perhaps use an environment
1197  * variable, or just call a script?
1198  *
1199  * @todo The /proc/ magic probably only works on Linux (and
1200  * Solaris?)  Can we be more portable?
1201  **/
1202 #ifdef MAINTAINER_MODE
1203 const char *get_panic_action(void)
1204 {
1205         const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1206
1207         if (cmd_fmt)
1208                 return cmd_fmt;
1209         else
1210                 return "xterm -display :0 -T Panic -n Panic "
1211                         "-e gdb /proc/%d/exe %d";
1212 }
1213
1214
1215 /**
1216  * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1217  *
1218  * This signal handler is only installed if we were configured with
1219  * --enable-maintainer-mode.  Perhaps it should always be on and we
1220  * should just look at the environment variable, but I'm a bit leery
1221  * of a signal sending us into a busy loop.
1222  **/
1223 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1224 {
1225         char cmd_buf[300];
1226         int ret;
1227
1228         sprintf(cmd_buf, get_panic_action(),
1229                 getpid(), getpid());
1230
1231         /* Unless we failed to execute gdb, we allow the process to
1232          * continue.  I'm not sure if that's right. */
1233         ret = system(cmd_buf);
1234         if (ret)
1235                 _exit(ret);
1236 }
1237 #endif
1238
1239
1240 int main(int argc,char *argv[])
1241 {
1242         int ret;
1243         int orig_argc = argc;
1244         char **orig_argv = argv;
1245 #ifdef HAVE_SIGACTION
1246 # ifdef HAVE_SIGPROCMASK
1247         sigset_t sigmask;
1248
1249         sigemptyset(&sigmask);
1250 # endif
1251         sigact.sa_flags = SA_NOCLDSTOP;
1252 #endif
1253         SIGACTMASK(SIGUSR1, sigusr1_handler);
1254         SIGACTMASK(SIGUSR2, sigusr2_handler);
1255         SIGACTMASK(SIGCHLD, remember_children);
1256 #ifdef MAINTAINER_MODE
1257         SIGACTMASK(SIGSEGV, rsync_panic_handler);
1258         SIGACTMASK(SIGFPE, rsync_panic_handler);
1259         SIGACTMASK(SIGABRT, rsync_panic_handler);
1260         SIGACTMASK(SIGBUS, rsync_panic_handler);
1261 #endif
1262
1263         starttime = time(NULL);
1264         am_root = (MY_UID() == 0);
1265
1266         memset(&stats, 0, sizeof(stats));
1267
1268         if (argc < 2) {
1269                 usage(FERROR);
1270                 exit_cleanup(RERR_SYNTAX);
1271         }
1272
1273         /* we set a 0 umask so that correct file permissions can be
1274          * carried across */
1275         orig_umask = umask(0);
1276
1277 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1278         setlocale(LC_CTYPE, "");
1279 #endif
1280
1281         if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1282                 /* FIXME: We ought to call the same error-handling
1283                  * code here, rather than relying on getopt. */
1284                 option_error();
1285                 exit_cleanup(RERR_SYNTAX);
1286         }
1287
1288         SIGACTMASK(SIGINT, sig_int);
1289         SIGACTMASK(SIGHUP, sig_int);
1290         SIGACTMASK(SIGTERM, sig_int);
1291 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1292         sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1293 #endif
1294
1295         /* Ignore SIGPIPE; we consistently check error codes and will
1296          * see the EPIPE. */
1297         SIGACTION(SIGPIPE, SIG_IGN);
1298 #ifdef SIGXFSZ
1299         SIGACTION(SIGXFSZ, SIG_IGN);
1300 #endif
1301
1302         /* Initialize push_dir here because on some old systems getcwd
1303          * (implemented by forking "pwd" and reading its output) doesn't
1304          * work when there are other child processes.  Also, on all systems
1305          * that implement getcwd that way "pwd" can't be found after chroot. */
1306         push_dir(NULL);
1307
1308         init_flist();
1309
1310         if ((write_batch || read_batch) && !am_server) {
1311                 if (write_batch)
1312                         write_batch_shell_file(orig_argc, orig_argv, argc);
1313
1314                 if (read_batch && strcmp(batch_name, "-") == 0)
1315                         batch_fd = STDIN_FILENO;
1316                 else {
1317                         batch_fd = do_open(batch_name,
1318                                    write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1319                                    : O_RDONLY, S_IRUSR | S_IWUSR);
1320                 }
1321                 if (batch_fd < 0) {
1322                         rsyserr(FERROR, errno, "Batch file %s open error",
1323                                 full_fname(batch_name));
1324                         exit_cleanup(RERR_FILEIO);
1325                 }
1326                 if (read_batch)
1327                         read_stream_flags(batch_fd);
1328         }
1329         if (write_batch < 0)
1330                 dry_run = 1;
1331
1332         if (am_daemon && !am_server)
1333                 return daemon_main();
1334
1335         if (argc < 1) {
1336                 usage(FERROR);
1337                 exit_cleanup(RERR_SYNTAX);
1338         }
1339
1340         if (am_server) {
1341                 set_nonblocking(STDIN_FILENO);
1342                 set_nonblocking(STDOUT_FILENO);
1343                 if (am_daemon)
1344                         return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1345                 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1346         }
1347
1348         ret = start_client(argc, argv);
1349         if (ret == -1)
1350                 exit_cleanup(RERR_STARTCLIENT);
1351         else
1352                 exit_cleanup(ret);
1353
1354         return ret;
1355 }