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