Simplified whole_file variable checking.
[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
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 /* This is only called by the sender. */
432 static void read_final_goodbye(int f_in, int f_out, int flist_count)
433 {
434         int i;
435
436         if (protocol_version < 29)
437                 i = read_int(f_in);
438         else {
439                 while ((i = read_int(f_in)) == flist_count
440                     && read_shortint(f_in) == ITEM_IS_NEW) {
441                         /* Forward the keep-alive (no-op) to the receiver. */
442                         write_int(f_out, flist_count);
443                         write_shortint(f_out, ITEM_IS_NEW);
444                 }
445         }
446
447         if (i != -1) {
448                 rprintf(FERROR, "Invalid packet from generator at end of run.\n");
449                 exit_cleanup(RERR_PROTOCOL);
450         }
451 }
452
453
454 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
455 {
456         int i;
457         struct file_list *flist;
458         char *dir = argv[0];
459
460         if (verbose > 2) {
461                 rprintf(FINFO, "server_sender starting pid=%ld\n",
462                         (long)getpid());
463         }
464
465         if (am_daemon && lp_write_only(module_id)) {
466                 rprintf(FERROR, "ERROR: module is write only\n");
467                 exit_cleanup(RERR_SYNTAX);
468                 return;
469         }
470         if (am_daemon && lp_read_only(module_id) && remove_sent_files) {
471                 rprintf(FERROR,
472                     "ERROR: --remove-sent-files cannot be used with a read-only module\n");
473                 exit_cleanup(RERR_SYNTAX);
474                 return;
475         }
476
477         if (!relative_paths && !push_dir(dir)) {
478                 rsyserr(FERROR, errno, "push_dir#3 %s failed",
479                         full_fname(dir));
480                 exit_cleanup(RERR_FILESELECT);
481         }
482         argc--;
483         argv++;
484
485         if (strcmp(dir,".")) {
486                 int l = strlen(dir);
487                 if (strcmp(dir,"/") == 0)
488                         l = 0;
489                 for (i = 0; i < argc; i++)
490                         argv[i] += l+1;
491         }
492
493         if (argc == 0 && (recurse || list_only)) {
494                 argc = 1;
495                 argv--;
496                 argv[0] = ".";
497         }
498
499         flist = send_file_list(f_out,argc,argv);
500         if (!flist || flist->count == 0) {
501                 exit_cleanup(0);
502         }
503
504         io_start_buffering_in();
505         io_start_buffering_out();
506
507         send_files(flist,f_out,f_in);
508         io_flush(FULL_FLUSH);
509         report(f_out);
510         if (protocol_version >= 24)
511                 read_final_goodbye(f_in, f_out, flist->count);
512         io_flush(FULL_FLUSH);
513         exit_cleanup(0);
514 }
515
516
517 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
518 {
519         int pid;
520         int status = 0;
521         int error_pipe[2], name_pipe[2];
522         BOOL need_name_pipe = (basis_dir[0] || partial_dir || fuzzy_basis
523                             || (inplace && make_backups)) && !dry_run;
524
525         /* The receiving side mustn't obey this, or an existing symlink that
526          * points to an identical file won't be replaced by the referent. */
527         copy_links = 0;
528
529         if (preserve_hard_links)
530                 init_hard_links(flist);
531
532         if (fd_pair(error_pipe) < 0
533             || (need_name_pipe && fd_pair(name_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 (need_name_pipe) {
548                         close(name_pipe[1]);
549                         set_blocking(name_pipe[0]);
550                 } else
551                         name_pipe[0] = -1;
552                 if (f_in != f_out)
553                         close(f_out);
554
555                 /* we can't let two processes write to the socket at one time */
556                 close_multiplexing_out();
557
558                 /* set place to send errors */
559                 set_msg_fd_out(error_pipe[1]);
560
561                 recv_files(f_in, flist, local_name, name_pipe[0]);
562                 io_flush(FULL_FLUSH);
563                 report(f_in);
564
565                 send_msg(MSG_DONE, "", 0);
566                 io_flush(FULL_FLUSH);
567
568                 /* Handle any keep-alive packets from the post-processing work
569                  * that the generator does. */
570                 if (protocol_version >= 29) {
571                         kluge_around_eof = -1;
572
573                         /* This should only get stopped via a USR2 signal. */
574                         while (read_int(f_in) == flist->count
575                             && read_shortint(f_in) == ITEM_IS_NEW) {}
576
577                         rprintf(FERROR, "Invalid packet from server at end of run.\n");
578                         exit_cleanup(RERR_PROTOCOL);
579                 }
580
581                 /* Finally, we go to sleep until our parent kills us with a
582                  * USR2 signal.  We sleep for a short time, as on some OSes
583                  * a signal won't interrupt a sleep! */
584                 while (1)
585                         msleep(20);
586         }
587
588         am_generator = 1;
589         close_multiplexing_in();
590         if (write_batch)
591                 stop_write_batch();
592
593         close(error_pipe[1]);
594         if (need_name_pipe) {
595                 close(name_pipe[0]);
596                 set_nonblocking(name_pipe[1]);
597         } else
598                 name_pipe[1] = -1;
599         if (f_in != f_out)
600                 close(f_in);
601
602         io_start_buffering_out();
603
604         set_msg_fd_in(error_pipe[0]);
605
606         generate_files(f_out, flist, local_name, name_pipe[1]);
607
608         report(-1);
609         io_flush(FULL_FLUSH);
610         if (protocol_version >= 24) {
611                 /* send a final goodbye message */
612                 write_int(f_out, -1);
613         }
614         io_flush(FULL_FLUSH);
615
616         set_msg_fd_in(-1);
617         kill(pid, SIGUSR2);
618         wait_process(pid, &status);
619         return status;
620 }
621
622
623 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
624 {
625         int status;
626         struct file_list *flist;
627         char *local_name = NULL;
628         char *dir = NULL;
629         int save_verbose = verbose;
630
631         if (filesfrom_fd >= 0) {
632                 /* We can't mix messages with files-from data on the socket,
633                  * so temporarily turn off verbose messages. */
634                 verbose = 0;
635         }
636
637         if (verbose > 2) {
638                 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
639                         argc, (long)getpid());
640         }
641
642         if (am_daemon && lp_read_only(module_id)) {
643                 rprintf(FERROR,"ERROR: module is read only\n");
644                 exit_cleanup(RERR_SYNTAX);
645                 return;
646         }
647
648
649         if (argc > 0) {
650                 dir = argv[0];
651                 argc--;
652                 argv++;
653                 if (!am_daemon && !push_dir(dir)) {
654                         rsyserr(FERROR, errno, "push_dir#4 %s failed",
655                                 full_fname(dir));
656                         exit_cleanup(RERR_FILESELECT);
657                 }
658         }
659
660         io_start_buffering_in();
661         recv_filter_list(f_in);
662
663         if (filesfrom_fd >= 0) {
664                 /* We need to send the files-from names to the sender at the
665                  * same time that we receive the file-list from them, so we
666                  * need the IO routines to automatically write out the names
667                  * onto our f_out socket as we read the file-list.  This
668                  * avoids both deadlock and extra delays/buffers. */
669                 io_set_filesfrom_fds(filesfrom_fd, f_out);
670                 filesfrom_fd = -1;
671         }
672
673         flist = recv_file_list(f_in);
674         verbose = save_verbose;
675         if (!flist) {
676                 rprintf(FERROR,"server_recv: recv_file_list error\n");
677                 exit_cleanup(RERR_FILESELECT);
678         }
679
680         if (argc > 0) {
681                 if (strcmp(dir,".")) {
682                         argv[0] += strlen(dir);
683                         if (argv[0][0] == '/')
684                                 argv[0]++;
685                 }
686                 local_name = get_local_name(flist,argv[0]);
687         }
688
689         status = do_recv(f_in,f_out,flist,local_name);
690         exit_cleanup(status);
691 }
692
693
694 int child_main(int argc, char *argv[])
695 {
696         start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
697         return 0;
698 }
699
700
701 void start_server(int f_in, int f_out, int argc, char *argv[])
702 {
703         set_nonblocking(f_in);
704         set_nonblocking(f_out);
705
706         io_set_sock_fds(f_in, f_out);
707         setup_protocol(f_out, f_in);
708
709         if (protocol_version >= 23)
710                 io_start_multiplex_out();
711
712         if (am_sender) {
713                 keep_dirlinks = 0; /* Must be disabled on the sender. */
714                 if (need_messages_from_generator)
715                         io_start_multiplex_in();
716
717                 recv_filter_list(f_in);
718                 do_server_sender(f_in, f_out, argc, argv);
719         } else {
720                 do_server_recv(f_in, f_out, argc, argv);
721         }
722         exit_cleanup(0);
723 }
724
725
726 /*
727  * This is called once the connection has been negotiated.  It is used
728  * for rsyncd, remote-shell, and local connections.
729  */
730 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
731 {
732         struct file_list *flist = NULL;
733         int status = 0, status2 = 0;
734         char *local_name = NULL;
735
736         cleanup_child_pid = pid;
737         if (!read_batch) {
738                 set_nonblocking(f_in);
739                 set_nonblocking(f_out);
740         }
741
742         io_set_sock_fds(f_in, f_out);
743         setup_protocol(f_out,f_in);
744
745         if (protocol_version >= 23 && !read_batch)
746                 io_start_multiplex_in();
747
748         /* We set our stderr file handle to blocking because ssh might have
749          * set it to non-blocking.  This can be particularly troublesome if
750          * stderr is a clone of stdout, because ssh would have set our stdout
751          * to non-blocking at the same time (which can easily cause us to lose
752          * output from our print statements).  This kluge shouldn't cause ssh
753          * any problems for how we use it.  Note also that we delayed setting
754          * this until after the above protocol setup so that we know for sure
755          * that ssh is done twiddling its file descriptors.  */
756         set_blocking(STDERR_FILENO);
757
758         if (am_sender) {
759                 keep_dirlinks = 0; /* Must be disabled on the sender. */
760                 io_start_buffering_out();
761                 if (!filesfrom_host)
762                         set_msg_fd_in(f_in);
763                 send_filter_list(f_out);
764                 if (filesfrom_host)
765                         filesfrom_fd = f_in;
766
767                 if (write_batch)
768                         start_write_batch(f_out);
769                 if (!read_batch) /* don't write to pipe */
770                         flist = send_file_list(f_out,argc,argv);
771                 set_msg_fd_in(-1);
772                 if (verbose > 3)
773                         rprintf(FINFO,"file list sent\n");
774
775                 io_flush(NORMAL_FLUSH);
776                 send_files(flist,f_out,f_in);
777                 io_flush(FULL_FLUSH);
778                 if (protocol_version >= 24)
779                         read_final_goodbye(f_in, f_out, flist->count);
780                 if (pid != -1) {
781                         if (verbose > 3)
782                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
783                         io_flush(FULL_FLUSH);
784                         wait_process(pid, &status);
785                 }
786                 report(-1);
787                 io_flush(FULL_FLUSH);
788                 exit_cleanup(status);
789         }
790
791         if (need_messages_from_generator && !read_batch)
792                 io_start_multiplex_out();
793
794         if (argc == 0)
795                 list_only |= 1;
796
797         send_filter_list(read_batch ? -1 : f_out);
798
799         if (filesfrom_fd >= 0) {
800                 io_set_filesfrom_fds(filesfrom_fd, f_out);
801                 filesfrom_fd = -1;
802         }
803
804         if (write_batch)
805                 start_write_batch(f_in);
806         flist = recv_file_list(f_in);
807         if (!flist || flist->count == 0) {
808                 rprintf(FINFO, "client: nothing to do: "
809                         "perhaps you need to specify some filenames or "
810                         "the --recursive option?\n");
811                 exit_cleanup(0);
812         }
813
814         local_name = get_local_name(flist,argv[0]);
815
816         status2 = do_recv(f_in,f_out,flist,local_name);
817
818         if (pid != -1) {
819                 if (verbose > 3)
820                         rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
821                 io_flush(FULL_FLUSH);
822                 wait_process(pid, &status);
823         }
824
825         return MAX(status, status2);
826 }
827
828 static int copy_argv (char *argv[])
829 {
830         int i;
831
832         for (i = 0; argv[i]; i++) {
833                 if (!(argv[i] = strdup(argv[i]))) {
834                         rprintf (FERROR, "out of memory at %s(%d)\n",
835                                  __FILE__, __LINE__);
836                         return RERR_MALLOC;
837                 }
838         }
839
840         return 0;
841 }
842
843
844 /**
845  * Start a client for either type of remote connection.  Work out
846  * whether the arguments request a remote shell or rsyncd connection,
847  * and call the appropriate connection function, then run_client.
848  *
849  * Calls either start_socket_client (for sockets) or do_cmd and
850  * client_run (for ssh).
851  **/
852 static int start_client(int argc, char *argv[])
853 {
854         char *p;
855         char *shell_machine = NULL;
856         char *shell_path = NULL;
857         char *shell_user = NULL;
858         int ret;
859         pid_t pid;
860         int f_in,f_out;
861         int rc;
862
863         /* Don't clobber argv[] so that ps(1) can still show the right
864          * command line. */
865         if ((rc = copy_argv(argv)))
866                 return rc;
867
868         if (!read_batch) { /* for read_batch, NO source is specified */
869                 argc--;
870                 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
871                 if (shell_path) { /* source is remote */
872                         argv++;
873                         if (filesfrom_host && *filesfrom_host
874                             && strcmp(filesfrom_host, shell_machine) != 0) {
875                                 rprintf(FERROR,
876                                         "--files-from hostname is not the same as the transfer hostname\n");
877                                 exit_cleanup(RERR_SYNTAX);
878                         }
879                         if (rsync_port) {
880                                 if (!shell_cmd) {
881                                         return start_socket_client(shell_machine,
882                                                                    shell_path,
883                                                                    argc, argv);
884                                 }
885                                 daemon_over_rsh = 1;
886                         }
887
888                         am_sender = 0;
889                 } else { /* source is local, check dest arg */
890                         am_sender = 1;
891
892                         if (argc < 1) { /* destination required */
893                                 usage(FERROR);
894                                 exit_cleanup(RERR_SYNTAX);
895                         }
896
897                         shell_path = check_for_hostspec(argv[argc], &shell_machine, &rsync_port);
898                         if (shell_path && filesfrom_host && *filesfrom_host
899                             && strcmp(filesfrom_host, shell_machine) != 0) {
900                                 rprintf(FERROR,
901                                         "--files-from hostname is not the same as the transfer hostname\n");
902                                 exit_cleanup(RERR_SYNTAX);
903                         }
904                         if (!shell_path) { /* no hostspec found, so src & dest are local */
905                                 local_server = 1;
906                                 if (filesfrom_host) {
907                                         rprintf(FERROR,
908                                                 "--files-from cannot be remote when the transfer is local\n");
909                                         exit_cleanup(RERR_SYNTAX);
910                                 }
911                                 shell_machine = NULL;
912                                 shell_path = argv[argc];
913                         } else if (rsync_port) {
914                                 if (!shell_cmd) {
915                                         return start_socket_client(shell_machine,
916                                                                    shell_path,
917                                                                    argc, argv);
918                                 }
919                                 daemon_over_rsh = 1;
920                         }
921                 }
922         } else {  /* read_batch */
923                 local_server = 1;
924                 shell_path = argv[argc-1];
925                 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
926                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
927                         exit_cleanup(RERR_SYNTAX);
928                 }
929         }
930
931         if (shell_machine) {
932                 p = strrchr(shell_machine,'@');
933                 if (p) {
934                         *p = 0;
935                         shell_user = shell_machine;
936                         shell_machine = p+1;
937                 }
938         }
939
940         if (verbose > 3) {
941                 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
942                         shell_cmd ? safe_fname(shell_cmd) : "",
943                         shell_machine ? safe_fname(shell_machine) : "",
944                         shell_user ? safe_fname(shell_user) : "",
945                         shell_path ? safe_fname(shell_path) : "");
946         }
947
948         /* for remote source, only single dest arg can remain ... */
949         if (!am_sender && argc > 1) {
950                 usage(FERROR);
951                 exit_cleanup(RERR_SYNTAX);
952         }
953
954         /* ... or no dest at all */
955         if (!am_sender && argc == 0)
956                 list_only |= 1;
957
958         pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
959                      &f_in,&f_out);
960
961         /* if we're running an rsync server on the remote host over a
962          * remote shell command, we need to do the RSYNCD protocol first */
963         if (daemon_over_rsh) {
964                 int tmpret;
965                 tmpret = start_inband_exchange(shell_user, shell_path,
966                                                f_in, f_out, argc);
967                 if (tmpret < 0)
968                         return tmpret;
969         }
970
971         ret = client_run(f_in, f_out, pid, argc, argv);
972
973         fflush(stdout);
974         fflush(stderr);
975
976         return ret;
977 }
978
979
980 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
981 {
982         exit_cleanup(RERR_SIGNAL);
983 }
984
985 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
986 {
987         close_all();
988         if (log_got_error) _exit(RERR_PARTIAL);
989         _exit(0);
990 }
991
992 static RETSIGTYPE sigchld_handler(UNUSED(int val))
993 {
994 #ifdef WNOHANG
995         int cnt, status;
996         pid_t pid;
997         /* An empty waitpid() loop was put here by Tridge and we could never
998          * get him to explain why he put it in, so rather than taking it
999          * out we're instead saving the child exit statuses for later use.
1000          * The waitpid() loop presumably eliminates all possibility of leaving
1001          * zombie children, maybe that's why he did it.
1002          */
1003         while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1004                 /* save the child's exit status */
1005                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1006                         if (pid_stat_table[cnt].pid == 0) {
1007                                 pid_stat_table[cnt].pid = pid;
1008                                 pid_stat_table[cnt].status = status;
1009                                 break;
1010                         }
1011                 }
1012         }
1013 #endif
1014 }
1015
1016
1017 /**
1018  * This routine catches signals and tries to send them to gdb.
1019  *
1020  * Because it's called from inside a signal handler it ought not to
1021  * use too many library routines.
1022  *
1023  * @todo Perhaps use "screen -X" instead/as well, to help people
1024  * debugging without easy access to X.  Perhaps use an environment
1025  * variable, or just call a script?
1026  *
1027  * @todo The /proc/ magic probably only works on Linux (and
1028  * Solaris?)  Can we be more portable?
1029  **/
1030 #ifdef MAINTAINER_MODE
1031 const char *get_panic_action(void)
1032 {
1033         const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1034
1035         if (cmd_fmt)
1036                 return cmd_fmt;
1037         else
1038                 return "xterm -display :0 -T Panic -n Panic "
1039                         "-e gdb /proc/%d/exe %d";
1040 }
1041
1042
1043 /**
1044  * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1045  *
1046  * This signal handler is only installed if we were configured with
1047  * --enable-maintainer-mode.  Perhaps it should always be on and we
1048  * should just look at the environment variable, but I'm a bit leery
1049  * of a signal sending us into a busy loop.
1050  **/
1051 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1052 {
1053         char cmd_buf[300];
1054         int ret;
1055
1056         sprintf(cmd_buf, get_panic_action(),
1057                 getpid(), getpid());
1058
1059         /* Unless we failed to execute gdb, we allow the process to
1060          * continue.  I'm not sure if that's right. */
1061         ret = system(cmd_buf);
1062         if (ret)
1063                 _exit(ret);
1064 }
1065 #endif
1066
1067
1068 int main(int argc,char *argv[])
1069 {
1070         int ret;
1071         int orig_argc = argc;
1072         char **orig_argv = argv;
1073
1074         signal(SIGUSR1, sigusr1_handler);
1075         signal(SIGUSR2, sigusr2_handler);
1076         signal(SIGCHLD, sigchld_handler);
1077 #ifdef MAINTAINER_MODE
1078         signal(SIGSEGV, rsync_panic_handler);
1079         signal(SIGFPE, rsync_panic_handler);
1080         signal(SIGABRT, rsync_panic_handler);
1081         signal(SIGBUS, rsync_panic_handler);
1082 #endif /* def MAINTAINER_MODE */
1083
1084         starttime = time(NULL);
1085         am_root = (MY_UID() == 0);
1086
1087         memset(&stats, 0, sizeof(stats));
1088
1089         if (argc < 2) {
1090                 usage(FERROR);
1091                 exit_cleanup(RERR_SYNTAX);
1092         }
1093
1094         /* we set a 0 umask so that correct file permissions can be
1095          * carried across */
1096         orig_umask = (int)umask(0);
1097
1098         if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1099                 /* FIXME: We ought to call the same error-handling
1100                  * code here, rather than relying on getopt. */
1101                 option_error();
1102                 exit_cleanup(RERR_SYNTAX);
1103         }
1104
1105         signal(SIGINT,SIGNAL_CAST sig_int);
1106         signal(SIGHUP,SIGNAL_CAST sig_int);
1107         signal(SIGTERM,SIGNAL_CAST sig_int);
1108
1109         /* Ignore SIGPIPE; we consistently check error codes and will
1110          * see the EPIPE. */
1111         signal(SIGPIPE, SIG_IGN);
1112
1113         /* Initialize push_dir here because on some old systems getcwd
1114          * (implemented by forking "pwd" and reading its output) doesn't
1115          * work when there are other child processes.  Also, on all systems
1116          * that implement getcwd that way "pwd" can't be found after chroot. */
1117         push_dir(NULL);
1118
1119         init_flist();
1120
1121         if (write_batch || read_batch) {
1122                 if (write_batch)
1123                         write_batch_shell_file(orig_argc, orig_argv, argc);
1124
1125                 if (read_batch && strcmp(batch_name, "-") == 0)
1126                         batch_fd = STDIN_FILENO;
1127                 else {
1128                         batch_fd = do_open(batch_name,
1129                                    write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1130                                    : O_RDONLY, S_IRUSR | S_IWUSR);
1131                 }
1132                 if (batch_fd < 0) {
1133                         rsyserr(FERROR, errno, "Batch file %s open error",
1134                                 full_fname(batch_name));
1135                         exit_cleanup(RERR_FILEIO);
1136                 }
1137                 if (read_batch)
1138                         read_stream_flags(batch_fd);
1139         }
1140
1141         if (am_daemon && !am_server)
1142                 return daemon_main();
1143
1144         if (argc < 1) {
1145                 usage(FERROR);
1146                 exit_cleanup(RERR_SYNTAX);
1147         }
1148
1149         if (am_server) {
1150                 set_nonblocking(STDIN_FILENO);
1151                 set_nonblocking(STDOUT_FILENO);
1152                 if (am_daemon)
1153                         return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1154                 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1155         }
1156
1157         ret = start_client(argc, argv);
1158         if (ret == -1)
1159                 exit_cleanup(RERR_STARTCLIENT);
1160         else
1161                 exit_cleanup(ret);
1162
1163         return ret;
1164 }