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