main.c

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