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