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