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