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