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