Mention the index number for an "invalid packet at end of run".
[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 kluge_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 *filesfrom_host;
62 extern char *partial_dir;
63 extern char *basis_dir[];
64 extern char *rsync_path;
65 extern char *shell_cmd;
66 extern char *batch_name;
67
68 int local_server = 0;
69 struct file_list *the_file_list;
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 /* This is only called by the sender. */
433 static void read_final_goodbye(int f_in, int f_out)
434 {
435         int i;
436
437         if (protocol_version < 29)
438                 i = read_int(f_in);
439         else {
440                 while ((i = read_int(f_in)) == the_file_list->count
441                     && read_shortint(f_in) == ITEM_IS_NEW) {
442                         /* Forward the keep-alive (no-op) to the receiver. */
443                         write_int(f_out, the_file_list->count);
444                         write_shortint(f_out, ITEM_IS_NEW);
445                 }
446         }
447
448         if (i != -1) {
449                 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
450                         i, who_am_i());
451                 exit_cleanup(RERR_PROTOCOL);
452         }
453 }
454
455
456 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
457 {
458         int i;
459         struct file_list *flist;
460         char *dir = argv[0];
461
462         if (verbose > 2) {
463                 rprintf(FINFO, "server_sender starting pid=%ld\n",
464                         (long)getpid());
465         }
466
467         if (am_daemon && lp_write_only(module_id)) {
468                 rprintf(FERROR, "ERROR: module is write only\n");
469                 exit_cleanup(RERR_SYNTAX);
470                 return;
471         }
472         if (am_daemon && lp_read_only(module_id) && remove_sent_files) {
473                 rprintf(FERROR,
474                     "ERROR: --remove-sent-files cannot be used with a read-only module\n");
475                 exit_cleanup(RERR_SYNTAX);
476                 return;
477         }
478
479         if (!relative_paths && !push_dir(dir)) {
480                 rsyserr(FERROR, errno, "push_dir#3 %s failed",
481                         full_fname(dir));
482                 exit_cleanup(RERR_FILESELECT);
483         }
484         argc--;
485         argv++;
486
487         if (strcmp(dir,".")) {
488                 int l = strlen(dir);
489                 if (strcmp(dir,"/") == 0)
490                         l = 0;
491                 for (i = 0; i < argc; i++)
492                         argv[i] += l+1;
493         }
494
495         if (argc == 0 && (recurse || list_only)) {
496                 argc = 1;
497                 argv--;
498                 argv[0] = ".";
499         }
500
501         flist = send_file_list(f_out,argc,argv);
502         if (!flist || flist->count == 0) {
503                 exit_cleanup(0);
504         }
505         the_file_list = flist;
506
507         io_start_buffering_in();
508         io_start_buffering_out();
509
510         send_files(flist,f_out,f_in);
511         io_flush(FULL_FLUSH);
512         report(f_out);
513         if (protocol_version >= 24)
514                 read_final_goodbye(f_in, f_out);
515         io_flush(FULL_FLUSH);
516         exit_cleanup(0);
517 }
518
519
520 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
521 {
522         int pid;
523         int status = 0;
524         int error_pipe[2];
525
526         /* The receiving side mustn't obey this, or an existing symlink that
527          * points to an identical file won't be replaced by the referent. */
528         copy_links = 0;
529
530         if (preserve_hard_links)
531                 init_hard_links();
532
533         if (fd_pair(error_pipe) < 0) {
534                 rsyserr(FERROR, errno, "pipe failed in do_recv");
535                 exit_cleanup(RERR_IPC);
536         }
537
538         io_flush(NORMAL_FLUSH);
539
540         if ((pid = do_fork()) == -1) {
541                 rsyserr(FERROR, errno, "fork failed in do_recv");
542                 exit_cleanup(RERR_IPC);
543         }
544
545         if (pid == 0) {
546                 close(error_pipe[0]);
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);
557                 io_flush(FULL_FLUSH);
558                 report(f_in);
559
560                 send_msg(MSG_DONE, "", 0);
561                 io_flush(FULL_FLUSH);
562
563                 /* Handle any keep-alive packets from the post-processing work
564                  * that the generator does. */
565                 if (protocol_version >= 29) {
566                         kluge_around_eof = -1;
567
568                         /* This should only get stopped via a USR2 signal. */
569                         while (read_int(f_in) == flist->count
570                             && read_shortint(f_in) == ITEM_IS_NEW) {}
571
572                         rprintf(FERROR, "Invalid packet at end of run [%s]\n",
573                                 who_am_i());
574                         exit_cleanup(RERR_PROTOCOL);
575                 }
576
577                 /* Finally, we go to sleep until our parent kills us with a
578                  * USR2 signal.  We sleep for a short time, as on some OSes
579                  * a signal won't interrupt a sleep! */
580                 while (1)
581                         msleep(20);
582         }
583
584         am_generator = 1;
585         close_multiplexing_in();
586         if (write_batch)
587                 stop_write_batch();
588
589         close(error_pipe[1]);
590         if (f_in != f_out)
591                 close(f_in);
592
593         io_start_buffering_out();
594
595         set_msg_fd_in(error_pipe[0]);
596
597         generate_files(f_out, flist, local_name);
598
599         report(-1);
600         io_flush(FULL_FLUSH);
601         if (protocol_version >= 24) {
602                 /* send a final goodbye message */
603                 write_int(f_out, -1);
604         }
605         io_flush(FULL_FLUSH);
606
607         set_msg_fd_in(-1);
608         kill(pid, SIGUSR2);
609         wait_process(pid, &status);
610         return status;
611 }
612
613
614 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
615 {
616         int status;
617         struct file_list *flist;
618         char *local_name = NULL;
619         char *dir = NULL;
620         int save_verbose = verbose;
621
622         if (filesfrom_fd >= 0) {
623                 /* We can't mix messages with files-from data on the socket,
624                  * so temporarily turn off verbose messages. */
625                 verbose = 0;
626         }
627
628         if (verbose > 2) {
629                 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
630                         argc, (long)getpid());
631         }
632
633         if (am_daemon && lp_read_only(module_id)) {
634                 rprintf(FERROR,"ERROR: module is read only\n");
635                 exit_cleanup(RERR_SYNTAX);
636                 return;
637         }
638
639
640         if (argc > 0) {
641                 dir = argv[0];
642                 argc--;
643                 argv++;
644                 if (!am_daemon && !push_dir(dir)) {
645                         rsyserr(FERROR, errno, "push_dir#4 %s failed",
646                                 full_fname(dir));
647                         exit_cleanup(RERR_FILESELECT);
648                 }
649         }
650
651         io_start_buffering_in();
652         recv_filter_list(f_in);
653
654         if (filesfrom_fd >= 0) {
655                 /* We need to send the files-from names to the sender at the
656                  * same time that we receive the file-list from them, so we
657                  * need the IO routines to automatically write out the names
658                  * onto our f_out socket as we read the file-list.  This
659                  * avoids both deadlock and extra delays/buffers. */
660                 io_set_filesfrom_fds(filesfrom_fd, f_out);
661                 filesfrom_fd = -1;
662         }
663
664         flist = recv_file_list(f_in);
665         verbose = save_verbose;
666         if (!flist) {
667                 rprintf(FERROR,"server_recv: recv_file_list error\n");
668                 exit_cleanup(RERR_FILESELECT);
669         }
670         the_file_list = flist;
671
672         if (argc > 0) {
673                 if (strcmp(dir,".")) {
674                         argv[0] += strlen(dir);
675                         if (argv[0][0] == '/')
676                                 argv[0]++;
677                 }
678                 local_name = get_local_name(flist,argv[0]);
679         }
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)
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                 if (protocol_version >= 24)
771                         read_final_goodbye(f_in, f_out);
772                 if (pid != -1) {
773                         if (verbose > 3)
774                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
775                         io_flush(FULL_FLUSH);
776                         wait_process(pid, &status);
777                 }
778                 report(-1);
779                 io_flush(FULL_FLUSH);
780                 exit_cleanup(status);
781         }
782
783         if (need_messages_from_generator && !read_batch)
784                 io_start_multiplex_out();
785
786         if (argc == 0)
787                 list_only |= 1;
788
789         send_filter_list(read_batch ? -1 : f_out);
790
791         if (filesfrom_fd >= 0) {
792                 io_set_filesfrom_fds(filesfrom_fd, f_out);
793                 filesfrom_fd = -1;
794         }
795
796         if (write_batch)
797                 start_write_batch(f_in);
798         flist = recv_file_list(f_in);
799         if (!flist || flist->count == 0) {
800                 rprintf(FINFO, "client: nothing to do: "
801                         "perhaps you need to specify some filenames or "
802                         "the --recursive option?\n");
803                 exit_cleanup(0);
804         }
805         the_file_list = flist;
806
807         local_name = get_local_name(flist,argv[0]);
808
809         status2 = do_recv(f_in,f_out,flist,local_name);
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                         argv++;
866                         if (filesfrom_host && *filesfrom_host
867                             && strcmp(filesfrom_host, shell_machine) != 0) {
868                                 rprintf(FERROR,
869                                         "--files-from hostname is not the same as the transfer hostname\n");
870                                 exit_cleanup(RERR_SYNTAX);
871                         }
872                         if (rsync_port) {
873                                 if (!shell_cmd) {
874                                         return start_socket_client(shell_machine,
875                                                                    shell_path,
876                                                                    argc, argv);
877                                 }
878                                 daemon_over_rsh = 1;
879                         }
880
881                         am_sender = 0;
882                 } else { /* source is local, check dest arg */
883                         am_sender = 1;
884
885                         if (argc < 1) { /* destination required */
886                                 usage(FERROR);
887                                 exit_cleanup(RERR_SYNTAX);
888                         }
889
890                         shell_path = check_for_hostspec(argv[argc], &shell_machine, &rsync_port);
891                         if (shell_path && filesfrom_host && *filesfrom_host
892                             && strcmp(filesfrom_host, shell_machine) != 0) {
893                                 rprintf(FERROR,
894                                         "--files-from hostname is not the same as the transfer hostname\n");
895                                 exit_cleanup(RERR_SYNTAX);
896                         }
897                         if (!shell_path) { /* no hostspec found, so src & dest are local */
898                                 local_server = 1;
899                                 if (filesfrom_host) {
900                                         rprintf(FERROR,
901                                                 "--files-from cannot be remote when the transfer is local\n");
902                                         exit_cleanup(RERR_SYNTAX);
903                                 }
904                                 shell_machine = NULL;
905                                 shell_path = argv[argc];
906                         } else if (rsync_port) {
907                                 if (!shell_cmd) {
908                                         return start_socket_client(shell_machine,
909                                                                    shell_path,
910                                                                    argc, argv);
911                                 }
912                                 daemon_over_rsh = 1;
913                         }
914                 }
915         } else {  /* read_batch */
916                 local_server = 1;
917                 shell_path = argv[argc-1];
918                 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
919                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
920                         exit_cleanup(RERR_SYNTAX);
921                 }
922         }
923
924         if (shell_machine) {
925                 p = strrchr(shell_machine,'@');
926                 if (p) {
927                         *p = 0;
928                         shell_user = shell_machine;
929                         shell_machine = p+1;
930                 }
931         }
932
933         if (verbose > 3) {
934                 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
935                         shell_cmd ? safe_fname(shell_cmd) : "",
936                         shell_machine ? safe_fname(shell_machine) : "",
937                         shell_user ? safe_fname(shell_user) : "",
938                         shell_path ? safe_fname(shell_path) : "");
939         }
940
941         /* for remote source, only single dest arg can remain ... */
942         if (!am_sender && argc > 1) {
943                 usage(FERROR);
944                 exit_cleanup(RERR_SYNTAX);
945         }
946
947         /* ... or no dest at all */
948         if (!am_sender && argc == 0)
949                 list_only |= 1;
950
951         pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
952                      &f_in,&f_out);
953
954         /* if we're running an rsync server on the remote host over a
955          * remote shell command, we need to do the RSYNCD protocol first */
956         if (daemon_over_rsh) {
957                 int tmpret;
958                 tmpret = start_inband_exchange(shell_user, shell_path,
959                                                f_in, f_out, argc);
960                 if (tmpret < 0)
961                         return tmpret;
962         }
963
964         ret = client_run(f_in, f_out, pid, argc, argv);
965
966         fflush(stdout);
967         fflush(stderr);
968
969         return ret;
970 }
971
972
973 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
974 {
975         exit_cleanup(RERR_SIGNAL);
976 }
977
978 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
979 {
980         close_all();
981         if (log_got_error) _exit(RERR_PARTIAL);
982         _exit(0);
983 }
984
985 static RETSIGTYPE sigchld_handler(UNUSED(int val))
986 {
987 #ifdef WNOHANG
988         int cnt, status;
989         pid_t pid;
990         /* An empty waitpid() loop was put here by Tridge and we could never
991          * get him to explain why he put it in, so rather than taking it
992          * out we're instead saving the child exit statuses for later use.
993          * The waitpid() loop presumably eliminates all possibility of leaving
994          * zombie children, maybe that's why he did it.
995          */
996         while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
997                 /* save the child's exit status */
998                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
999                         if (pid_stat_table[cnt].pid == 0) {
1000                                 pid_stat_table[cnt].pid = pid;
1001                                 pid_stat_table[cnt].status = status;
1002                                 break;
1003                         }
1004                 }
1005         }
1006 #endif
1007 }
1008
1009
1010 /**
1011  * This routine catches signals and tries to send them to gdb.
1012  *
1013  * Because it's called from inside a signal handler it ought not to
1014  * use too many library routines.
1015  *
1016  * @todo Perhaps use "screen -X" instead/as well, to help people
1017  * debugging without easy access to X.  Perhaps use an environment
1018  * variable, or just call a script?
1019  *
1020  * @todo The /proc/ magic probably only works on Linux (and
1021  * Solaris?)  Can we be more portable?
1022  **/
1023 #ifdef MAINTAINER_MODE
1024 const char *get_panic_action(void)
1025 {
1026         const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1027
1028         if (cmd_fmt)
1029                 return cmd_fmt;
1030         else
1031                 return "xterm -display :0 -T Panic -n Panic "
1032                         "-e gdb /proc/%d/exe %d";
1033 }
1034
1035
1036 /**
1037  * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1038  *
1039  * This signal handler is only installed if we were configured with
1040  * --enable-maintainer-mode.  Perhaps it should always be on and we
1041  * should just look at the environment variable, but I'm a bit leery
1042  * of a signal sending us into a busy loop.
1043  **/
1044 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1045 {
1046         char cmd_buf[300];
1047         int ret;
1048
1049         sprintf(cmd_buf, get_panic_action(),
1050                 getpid(), getpid());
1051
1052         /* Unless we failed to execute gdb, we allow the process to
1053          * continue.  I'm not sure if that's right. */
1054         ret = system(cmd_buf);
1055         if (ret)
1056                 _exit(ret);
1057 }
1058 #endif
1059
1060
1061 int main(int argc,char *argv[])
1062 {
1063         int ret;
1064         int orig_argc = argc;
1065         char **orig_argv = argv;
1066
1067         signal(SIGUSR1, sigusr1_handler);
1068         signal(SIGUSR2, sigusr2_handler);
1069         signal(SIGCHLD, sigchld_handler);
1070 #ifdef MAINTAINER_MODE
1071         signal(SIGSEGV, rsync_panic_handler);
1072         signal(SIGFPE, rsync_panic_handler);
1073         signal(SIGABRT, rsync_panic_handler);
1074         signal(SIGBUS, rsync_panic_handler);
1075 #endif /* def MAINTAINER_MODE */
1076
1077         starttime = time(NULL);
1078         am_root = (MY_UID() == 0);
1079
1080         memset(&stats, 0, sizeof(stats));
1081
1082         if (argc < 2) {
1083                 usage(FERROR);
1084                 exit_cleanup(RERR_SYNTAX);
1085         }
1086
1087         /* we set a 0 umask so that correct file permissions can be
1088          * carried across */
1089         orig_umask = (int)umask(0);
1090
1091         if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1092                 /* FIXME: We ought to call the same error-handling
1093                  * code here, rather than relying on getopt. */
1094                 option_error();
1095                 exit_cleanup(RERR_SYNTAX);
1096         }
1097
1098         signal(SIGINT,SIGNAL_CAST sig_int);
1099         signal(SIGHUP,SIGNAL_CAST sig_int);
1100         signal(SIGTERM,SIGNAL_CAST sig_int);
1101
1102         /* Ignore SIGPIPE; we consistently check error codes and will
1103          * see the EPIPE. */
1104         signal(SIGPIPE, SIG_IGN);
1105
1106         /* Initialize push_dir here because on some old systems getcwd
1107          * (implemented by forking "pwd" and reading its output) doesn't
1108          * work when there are other child processes.  Also, on all systems
1109          * that implement getcwd that way "pwd" can't be found after chroot. */
1110         push_dir(NULL);
1111
1112         init_flist();
1113
1114         if (write_batch || read_batch) {
1115                 if (write_batch)
1116                         write_batch_shell_file(orig_argc, orig_argv, argc);
1117
1118                 if (read_batch && strcmp(batch_name, "-") == 0)
1119                         batch_fd = STDIN_FILENO;
1120                 else {
1121                         batch_fd = do_open(batch_name,
1122                                    write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1123                                    : O_RDONLY, S_IRUSR | S_IWUSR);
1124                 }
1125                 if (batch_fd < 0) {
1126                         rsyserr(FERROR, errno, "Batch file %s open error",
1127                                 full_fname(batch_name));
1128                         exit_cleanup(RERR_FILEIO);
1129                 }
1130                 if (read_batch)
1131                         read_stream_flags(batch_fd);
1132         }
1133
1134         if (am_daemon && !am_server)
1135                 return daemon_main();
1136
1137         if (argc < 1) {
1138                 usage(FERROR);
1139                 exit_cleanup(RERR_SYNTAX);
1140         }
1141
1142         if (am_server) {
1143                 set_nonblocking(STDIN_FILENO);
1144                 set_nonblocking(STDOUT_FILENO);
1145                 if (am_daemon)
1146                         return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1147                 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1148         }
1149
1150         ret = start_client(argc, argv);
1151         if (ret == -1)
1152                 exit_cleanup(RERR_STARTCLIENT);
1153         else
1154                 exit_cleanup(ret);
1155
1156         return ret;
1157 }