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