main.c

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