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