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