main.c

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