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