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