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