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                 /* Caution: flist->count could be 0! */
 484                 if (flist->count == 1 && S_ISDIR(flist->files[0]->mode)) {
 485                         rprintf(FERROR,
 486                                 "ERROR: cannot overwrite non-directory"
 487                                 " with a directory\n");
 488                         exit_cleanup(RERR_FILESELECT);
 489                 }
 490         } else if (errno != ENOENT) {
 491                 rsyserr(FERROR, errno, "cannot stat destination %s",
 492                         full_fname(dest_path));
 493                 exit_cleanup(RERR_FILESELECT);
 494         }
 495
 496         cp = strrchr(dest_path, '/');
 497
 498         /* If the destination path ends in a slash or we are transferring
 499          * multiple files, create a directory at the destination path,
 500          * enter the new directory, and use mode 1. */
 501         if (flist->count > 1 || (cp && !cp[1])) {
 502                 /* Lop off the final slash (if any). */
 503                 if (cp && !cp[1])
 504                         *cp = '\0';
 505
 506                 if (mkdir_defmode(dest_path) != 0) {
 507                         rsyserr(FERROR, errno, "mkdir %s failed",
 508                                 full_fname(dest_path));
 509                         exit_cleanup(RERR_FILEIO);
 510                 }
 511
 512                 if (verbose)
 513                         rprintf(FINFO, "created directory %s\n", dest_path);
 514
 515                 if (dry_run) {
 516                         /* Indicate that the destination directory doesn't
 517                          * really exist and return mode 1. */
 518                         dry_run++;
 519                         return NULL;
 520                 }
 521
 522                 if (!push_dir(dest_path)) {
 523                         rsyserr(FERROR, errno, "push_dir#2 %s failed",
 524                                 full_fname(dest_path));
 525                         exit_cleanup(RERR_FILESELECT);
 526                 }
 527
 528                 return NULL;
 529         }
 530
 531         /* Otherwise, we are writing a single file, possibly on top of an
 532          * existing non-directory.  Change to the item's parent directory
 533          * (if it has a path component), return the basename of the
 534          * destination file as the local name, and use mode 2. */
 535         if (!cp)
 536                 return dest_path;
 537
 538         if (cp == dest_path)
 539                 dest_path = "/";
 540
 541         *cp = '\0';
 542         if (!push_dir(dest_path)) {
 543                 rsyserr(FERROR, errno, "push_dir#3 %s failed",
 544                         full_fname(dest_path));
 545                 exit_cleanup(RERR_FILESELECT);
 546         }
 547         *cp = '/';
 548
 549         return cp + 1;
 550 }
 551
 552
 553 /* This is only called by the sender. */
 554 static void read_final_goodbye(int f_in, int f_out)
 555 {
 556         int i;
 557
 558         if (protocol_version < 29)
 559                 i = read_int(f_in);
 560         else {
 561                 while ((i = read_int(f_in)) == the_file_list->count
 562                     && read_shortint(f_in) == ITEM_IS_NEW) {
 563                         /* Forward the keep-alive (no-op) to the receiver. */
 564                         write_int(f_out, the_file_list->count);
 565                         write_shortint(f_out, ITEM_IS_NEW);
 566                 }
 567         }
 568
 569         if (i != -1) {
 570                 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
 571                         i, who_am_i());
 572                 exit_cleanup(RERR_PROTOCOL);
 573         }
 574 }
 575
 576
 577 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
 578 {
 579         struct file_list *flist;
 580         char *dir = argv[0];
 581
 582         if (verbose > 2) {
 583                 rprintf(FINFO, "server_sender starting pid=%ld\n",
 584                         (long)getpid());
 585         }
 586
 587         if (am_daemon && lp_write_only(module_id)) {
 588                 rprintf(FERROR, "ERROR: module is write only\n");
 589                 exit_cleanup(RERR_SYNTAX);
 590                 return;
 591         }
 592         if (am_daemon && lp_read_only(module_id) && remove_sent_files) {
 593                 rprintf(FERROR,
 594                     "ERROR: --remove-sent-files cannot be used with a read-only module\n");
 595                 exit_cleanup(RERR_SYNTAX);
 596                 return;
 597         }
 598
 599         if (!relative_paths && !push_dir(dir)) {
 600                 rsyserr(FERROR, errno, "push_dir#3 %s failed",
 601                         full_fname(dir));
 602                 exit_cleanup(RERR_FILESELECT);
 603         }
 604         argc--;
 605         argv++;
 606
 607         if (argc == 0 && (recurse || list_only)) {
 608                 argc = 1;
 609                 argv--;
 610                 argv[0] = ".";
 611         }
 612
 613         flist = send_file_list(f_out,argc,argv);
 614         if (!flist || flist->count == 0) {
 615                 exit_cleanup(0);
 616         }
 617         the_file_list = flist;
 618
 619         io_start_buffering_in();
 620         io_start_buffering_out();
 621
 622         send_files(flist,f_out,f_in);
 623         io_flush(FULL_FLUSH);
 624         handle_stats(f_out);
 625         if (protocol_version >= 24)
 626                 read_final_goodbye(f_in, f_out);
 627         io_flush(FULL_FLUSH);
 628         exit_cleanup(0);
 629 }
 630
 631
 632 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
 633 {
 634         int pid;
 635         int exit_code = 0;
 636         int error_pipe[2];
 637
 638         /* The receiving side mustn't obey this, or an existing symlink that
 639          * points to an identical file won't be replaced by the referent. */
 640         copy_links = copy_dirlinks = 0;
 641
 642         if (preserve_hard_links)
 643                 init_hard_links();
 644
 645         if (fd_pair(error_pipe) < 0) {
 646                 rsyserr(FERROR, errno, "pipe failed in do_recv");
 647                 exit_cleanup(RERR_IPC);
 648         }
 649
 650         io_flush(NORMAL_FLUSH);
 651
 652         if ((pid = do_fork()) == -1) {
 653                 rsyserr(FERROR, errno, "fork failed in do_recv");
 654                 exit_cleanup(RERR_IPC);
 655         }
 656
 657         if (pid == 0) {
 658                 close(error_pipe[0]);
 659                 if (f_in != f_out)
 660                         close(f_out);
 661
 662                 /* we can't let two processes write to the socket at one time */
 663                 close_multiplexing_out();
 664
 665                 /* set place to send errors */
 666                 set_msg_fd_out(error_pipe[1]);
 667
 668                 recv_files(f_in, flist, local_name);
 669                 io_flush(FULL_FLUSH);
 670                 handle_stats(f_in);
 671
 672                 send_msg(MSG_DONE, "", 0);
 673                 io_flush(FULL_FLUSH);
 674
 675                 /* Handle any keep-alive packets from the post-processing work
 676                  * that the generator does. */
 677                 if (protocol_version >= 29) {
 678                         kluge_around_eof = -1;
 679
 680                         /* This should only get stopped via a USR2 signal. */
 681                         while (read_int(f_in) == flist->count
 682                             && read_shortint(f_in) == ITEM_IS_NEW) {}
 683
 684                         rprintf(FERROR, "Invalid packet at end of run [%s]\n",
 685                                 who_am_i());
 686                         exit_cleanup(RERR_PROTOCOL);
 687                 }
 688
 689                 /* Finally, we go to sleep until our parent kills us with a
 690                  * USR2 signal.  We sleep for a short time, as on some OSes
 691                  * a signal won't interrupt a sleep! */
 692                 while (1)
 693                         msleep(20);
 694         }
 695
 696         am_generator = 1;
 697         close_multiplexing_in();
 698         if (write_batch && !am_server)
 699                 stop_write_batch();
 700
 701         close(error_pipe[1]);
 702         if (f_in != f_out)
 703                 close(f_in);
 704
 705         io_start_buffering_out();
 706
 707         set_msg_fd_in(error_pipe[0]);
 708
 709         generate_files(f_out, flist, local_name);
 710
 711         handle_stats(-1);
 712         io_flush(FULL_FLUSH);
 713         if (protocol_version >= 24) {
 714                 /* send a final goodbye message */
 715                 write_int(f_out, -1);
 716         }
 717         io_flush(FULL_FLUSH);
 718
 719         set_msg_fd_in(-1);
 720         kill(pid, SIGUSR2);
 721         wait_process_with_flush(pid, &exit_code);
 722         return exit_code;
 723 }
 724
 725
 726 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
 727 {
 728         int exit_code;
 729         struct file_list *flist;
 730         char *local_name = NULL;
 731         char *dir = NULL;
 732         int save_verbose = verbose;
 733
 734         if (filesfrom_fd >= 0) {
 735                 /* We can't mix messages with files-from data on the socket,
 736                  * so temporarily turn off verbose messages. */
 737                 verbose = 0;
 738         }
 739
 740         if (verbose > 2) {
 741                 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
 742                         argc, (long)getpid());
 743         }
 744
 745         if (am_daemon && lp_read_only(module_id)) {
 746                 rprintf(FERROR,"ERROR: module is read only\n");
 747                 exit_cleanup(RERR_SYNTAX);
 748                 return;
 749         }
 750
 751         if (argc > 0) {
 752                 dir = argv[0];
 753                 argc--;
 754                 argv++;
 755                 if (!am_daemon && !push_dir(dir)) {
 756                         rsyserr(FERROR, errno, "push_dir#4 %s failed",
 757                                 full_fname(dir));
 758                         exit_cleanup(RERR_FILESELECT);
 759                 }
 760         }
 761
 762         io_start_buffering_in();
 763         recv_filter_list(f_in);
 764
 765         if (filesfrom_fd >= 0) {
 766                 /* We need to send the files-from names to the sender at the
 767                  * same time that we receive the file-list from them, so we
 768                  * need the IO routines to automatically write out the names
 769                  * onto our f_out socket as we read the file-list.  This
 770                  * avoids both deadlock and extra delays/buffers. */
 771                 io_set_filesfrom_fds(filesfrom_fd, f_out);
 772                 filesfrom_fd = -1;
 773         }
 774
 775         flist = recv_file_list(f_in);
 776         verbose = save_verbose;
 777         if (!flist) {
 778                 rprintf(FERROR,"server_recv: recv_file_list error\n");
 779                 exit_cleanup(RERR_FILESELECT);
 780         }
 781         the_file_list = flist;
 782
 783         if (argc > 0)
 784                 local_name = get_local_name(flist,argv[0]);
 785
 786         exit_code = do_recv(f_in,f_out,flist,local_name);
 787         exit_cleanup(exit_code);
 788 }
 789
 790
 791 int child_main(int argc, char *argv[])
 792 {
 793         start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
 794         return 0;
 795 }
 796
 797
 798 void start_server(int f_in, int f_out, int argc, char *argv[])
 799 {
 800         set_nonblocking(f_in);
 801         set_nonblocking(f_out);
 802
 803         io_set_sock_fds(f_in, f_out);
 804         setup_protocol(f_out, f_in);
 805 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
 806         setup_iconv();
 807 #endif
 808
 809         if (protocol_version >= 23)
 810                 io_start_multiplex_out();
 811
 812         if (am_sender) {
 813                 keep_dirlinks = 0; /* Must be disabled on the sender. */
 814                 if (need_messages_from_generator)
 815                         io_start_multiplex_in();
 816
 817                 recv_filter_list(f_in);
 818                 do_server_sender(f_in, f_out, argc, argv);
 819         } else {
 820                 do_server_recv(f_in, f_out, argc, argv);
 821         }
 822         exit_cleanup(0);
 823 }
 824
 825
 826 /*
 827  * This is called once the connection has been negotiated.  It is used
 828  * for rsyncd, remote-shell, and local connections.
 829  */
 830 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
 831 {
 832         struct file_list *flist = NULL;
 833         int exit_code = 0, exit_code2 = 0;
 834         char *local_name = NULL;
 835
 836         cleanup_child_pid = pid;
 837         if (!read_batch) {
 838                 set_nonblocking(f_in);
 839                 set_nonblocking(f_out);
 840         }
 841
 842         io_set_sock_fds(f_in, f_out);
 843         setup_protocol(f_out,f_in);
 844 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
 845         setup_iconv();
 846 #endif
 847
 848         if (protocol_version >= 23 && !read_batch)
 849                 io_start_multiplex_in();
 850
 851         /* We set our stderr file handle to blocking because ssh might have
 852          * set it to non-blocking.  This can be particularly troublesome if
 853          * stderr is a clone of stdout, because ssh would have set our stdout
 854          * to non-blocking at the same time (which can easily cause us to lose
 855          * output from our print statements).  This kluge shouldn't cause ssh
 856          * any problems for how we use it.  Note also that we delayed setting
 857          * this until after the above protocol setup so that we know for sure
 858          * that ssh is done twiddling its file descriptors.  */
 859         set_blocking(STDERR_FILENO);
 860
 861         if (am_sender) {
 862                 keep_dirlinks = 0; /* Must be disabled on the sender. */
 863                 io_start_buffering_out();
 864                 if (!filesfrom_host)
 865                         set_msg_fd_in(f_in);
 866                 send_filter_list(f_out);
 867                 if (filesfrom_host)
 868                         filesfrom_fd = f_in;
 869
 870                 if (write_batch && !am_server)
 871                         start_write_batch(f_out);
 872                 flist = send_file_list(f_out, argc, argv);
 873                 set_msg_fd_in(-1);
 874                 if (verbose > 3)
 875                         rprintf(FINFO,"file list sent\n");
 876                 the_file_list = flist;
 877
 878                 io_flush(NORMAL_FLUSH);
 879                 send_files(flist,f_out,f_in);
 880                 io_flush(FULL_FLUSH);
 881                 handle_stats(-1);
 882                 if (protocol_version >= 24)
 883                         read_final_goodbye(f_in, f_out);
 884                 if (pid != -1) {
 885                         if (verbose > 3)
 886                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
 887                         io_flush(FULL_FLUSH);
 888                         wait_process_with_flush(pid, &exit_code);
 889                 }
 890                 output_summary();
 891                 io_flush(FULL_FLUSH);
 892                 exit_cleanup(exit_code);
 893         }
 894
 895         if (need_messages_from_generator && !read_batch)
 896                 io_start_multiplex_out();
 897
 898         if (argc == 0)
 899                 list_only |= 1;
 900
 901         send_filter_list(read_batch ? -1 : f_out);
 902
 903         if (filesfrom_fd >= 0) {
 904                 io_set_filesfrom_fds(filesfrom_fd, f_out);
 905                 filesfrom_fd = -1;
 906         }
 907
 908         if (write_batch && !am_server)
 909                 start_write_batch(f_in);
 910         flist = recv_file_list(f_in);
 911         the_file_list = flist;
 912
 913         if (flist && flist->count > 0) {
 914                 local_name = get_local_name(flist, argv[0]);
 915
 916                 exit_code2 = do_recv(f_in, f_out, flist, local_name);
 917         } else {
 918                 handle_stats(-1);
 919                 output_summary();
 920         }
 921
 922         if (pid != -1) {
 923                 if (verbose > 3)
 924                         rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
 925                 io_flush(FULL_FLUSH);
 926                 wait_process_with_flush(pid, &exit_code);
 927         }
 928
 929         return MAX(exit_code, exit_code2);
 930 }
 931
 932 static int copy_argv (char *argv[])
 933 {
 934         int i;
 935
 936         for (i = 0; argv[i]; i++) {
 937                 if (!(argv[i] = strdup(argv[i]))) {
 938                         rprintf (FERROR, "out of memory at %s(%d)\n",
 939                                  __FILE__, __LINE__);
 940                         return RERR_MALLOC;
 941                 }
 942         }
 943
 944         return 0;
 945 }
 946
 947
 948 /**
 949  * Start a client for either type of remote connection.  Work out
 950  * whether the arguments request a remote shell or rsyncd connection,
 951  * and call the appropriate connection function, then run_client.
 952  *
 953  * Calls either start_socket_client (for sockets) or do_cmd and
 954  * client_run (for ssh).
 955  **/
 956 static int start_client(int argc, char *argv[])
 957 {
 958         char *p;
 959         char *shell_machine = NULL;
 960         char *shell_path = NULL;
 961         char *shell_user = NULL;
 962         int ret;
 963         pid_t pid;
 964         int f_in,f_out;
 965         int rc;
 966
 967         /* Don't clobber argv[] so that ps(1) can still show the right
 968          * command line. */
 969         if ((rc = copy_argv(argv)))
 970                 return rc;
 971
 972         if (!read_batch) { /* for read_batch, NO source is specified */
 973                 shell_path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
 974                 if (shell_path) { /* source is remote */
 975                         char *dummy1;
 976                         int dummy2;
 977                         if (--argc
 978                          && check_for_hostspec(argv[argc], &dummy1, &dummy2)) {
 979                                 rprintf(FERROR,
 980                                         "The source and destination cannot both be remote.\n");
 981                                 exit_cleanup(RERR_SYNTAX);
 982                         }
 983                         argv++;
 984                         if (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 (rsync_port) {
 991                                 if (!shell_cmd) {
 992                                         return start_socket_client(shell_machine,
 993                                                                    shell_path,
 994                                                                    argc, argv);
 995                                 }
 996                                 daemon_over_rsh = 1;
 997                         }
 998
 999                         am_sender = 0;
1000                 } else { /* source is local, check dest arg */
1001                         am_sender = 1;
1002
1003                         if (argc > 1)
1004                                 p = argv[--argc];
1005                         else {
1006                                 p = ".";
1007                                 list_only = 1;
1008                         }
1009
1010                         shell_path = check_for_hostspec(p, &shell_machine, &rsync_port);
1011                         if (shell_path && filesfrom_host && *filesfrom_host
1012                             && strcmp(filesfrom_host, shell_machine) != 0) {
1013                                 rprintf(FERROR,
1014                                         "--files-from hostname is not the same as the transfer hostname\n");
1015                                 exit_cleanup(RERR_SYNTAX);
1016                         }
1017                         if (!shell_path) { /* no hostspec found, so src & dest are local */
1018                                 local_server = 1;
1019                                 if (filesfrom_host) {
1020                                         rprintf(FERROR,
1021                                                 "--files-from cannot be remote when the transfer is local\n");
1022                                         exit_cleanup(RERR_SYNTAX);
1023                                 }
1024                                 shell_machine = NULL;
1025                                 shell_path = p;
1026                         } else if (rsync_port) {
1027                                 if (!shell_cmd) {
1028                                         return start_socket_client(shell_machine,
1029                                                                    shell_path,
1030                                                                    argc, argv);
1031                                 }
1032                                 daemon_over_rsh = 1;
1033                         }
1034                 }
1035         } else {  /* read_batch */
1036                 local_server = 1;
1037                 shell_path = argv[argc-1];
1038                 if (check_for_hostspec(shell_path, &shell_machine, &rsync_port)) {
1039                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1040                         exit_cleanup(RERR_SYNTAX);
1041                 }
1042         }
1043
1044         if (shell_machine) {
1045                 p = strrchr(shell_machine,'@');
1046                 if (p) {
1047                         *p = 0;
1048                         shell_user = shell_machine;
1049                         shell_machine = p+1;
1050                 }
1051         }
1052
1053         if (verbose > 3) {
1054                 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1055                         shell_cmd ? shell_cmd : "",
1056                         shell_machine ? shell_machine : "",
1057                         shell_user ? shell_user : "",
1058                         shell_path ? shell_path : "");
1059         }
1060
1061         /* for remote source, only single dest arg can remain ... */
1062         if (!am_sender && argc > 1) {
1063                 usage(FERROR);
1064                 exit_cleanup(RERR_SYNTAX);
1065         }
1066
1067         /* ... or no dest at all */
1068         if (!am_sender && argc == 0)
1069                 list_only |= 1;
1070
1071         pid = do_cmd(shell_cmd,shell_machine,shell_user,shell_path,
1072                      &f_in,&f_out);
1073
1074         /* if we're running an rsync server on the remote host over a
1075          * remote shell command, we need to do the RSYNCD protocol first */
1076         if (daemon_over_rsh) {
1077                 int tmpret;
1078                 tmpret = start_inband_exchange(shell_user, shell_path,
1079                                                f_in, f_out, argc);
1080                 if (tmpret < 0)
1081                         return tmpret;
1082         }
1083
1084         ret = client_run(f_in, f_out, pid, argc, argv);
1085
1086         fflush(stdout);
1087         fflush(stderr);
1088
1089         return ret;
1090 }
1091
1092
1093 static RETSIGTYPE sigusr1_handler(UNUSED(int val))
1094 {
1095         exit_cleanup(RERR_SIGNAL1);
1096 }
1097
1098 static RETSIGTYPE sigusr2_handler(UNUSED(int val))
1099 {
1100         if (!am_server)
1101                 output_summary();
1102         close_all();
1103         if (log_got_error)
1104                 _exit(RERR_PARTIAL);
1105         _exit(0);
1106 }
1107
1108 RETSIGTYPE remember_children(UNUSED(int val))
1109 {
1110 #ifdef WNOHANG
1111         int cnt, status;
1112         pid_t pid;
1113         /* An empty waitpid() loop was put here by Tridge and we could never
1114          * get him to explain why he put it in, so rather than taking it
1115          * out we're instead saving the child exit statuses for later use.
1116          * The waitpid() loop presumably eliminates all possibility of leaving
1117          * zombie children, maybe that's why he did it. */
1118         while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1119                 /* save the child's exit status */
1120                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1121                         if (pid_stat_table[cnt].pid == 0) {
1122                                 pid_stat_table[cnt].pid = pid;
1123                                 pid_stat_table[cnt].status = status;
1124                                 break;
1125                         }
1126                 }
1127         }
1128 #endif
1129 #ifndef HAVE_SIGACTION
1130         signal(SIGCHLD, remember_children);
1131 #endif
1132 }
1133
1134
1135 /**
1136  * This routine catches signals and tries to send them to gdb.
1137  *
1138  * Because it's called from inside a signal handler it ought not to
1139  * use too many library routines.
1140  *
1141  * @todo Perhaps use "screen -X" instead/as well, to help people
1142  * debugging without easy access to X.  Perhaps use an environment
1143  * variable, or just call a script?
1144  *
1145  * @todo The /proc/ magic probably only works on Linux (and
1146  * Solaris?)  Can we be more portable?
1147  **/
1148 #ifdef MAINTAINER_MODE
1149 const char *get_panic_action(void)
1150 {
1151         const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1152
1153         if (cmd_fmt)
1154                 return cmd_fmt;
1155         else
1156                 return "xterm -display :0 -T Panic -n Panic "
1157                         "-e gdb /proc/%d/exe %d";
1158 }
1159
1160
1161 /**
1162  * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1163  *
1164  * This signal handler is only installed if we were configured with
1165  * --enable-maintainer-mode.  Perhaps it should always be on and we
1166  * should just look at the environment variable, but I'm a bit leery
1167  * of a signal sending us into a busy loop.
1168  **/
1169 static RETSIGTYPE rsync_panic_handler(UNUSED(int whatsig))
1170 {
1171         char cmd_buf[300];
1172         int ret;
1173
1174         sprintf(cmd_buf, get_panic_action(),
1175                 getpid(), getpid());
1176
1177         /* Unless we failed to execute gdb, we allow the process to
1178          * continue.  I'm not sure if that's right. */
1179         ret = system(cmd_buf);
1180         if (ret)
1181                 _exit(ret);
1182 }
1183 #endif
1184
1185
1186 int main(int argc,char *argv[])
1187 {
1188         int ret;
1189         int orig_argc = argc;
1190         char **orig_argv = argv;
1191 #ifdef HAVE_SIGACTION
1192 # ifdef HAVE_SIGPROCMASK
1193         sigset_t sigmask;
1194
1195         sigemptyset(&sigmask);
1196 # endif
1197         sigact.sa_flags = SA_NOCLDSTOP;
1198 #endif
1199         SIGACTMASK(SIGUSR1, sigusr1_handler);
1200         SIGACTMASK(SIGUSR2, sigusr2_handler);
1201         SIGACTMASK(SIGCHLD, remember_children);
1202 #ifdef MAINTAINER_MODE
1203         SIGACTMASK(SIGSEGV, rsync_panic_handler);
1204         SIGACTMASK(SIGFPE, rsync_panic_handler);
1205         SIGACTMASK(SIGABRT, rsync_panic_handler);
1206         SIGACTMASK(SIGBUS, rsync_panic_handler);
1207 #endif
1208
1209         starttime = time(NULL);
1210         am_root = (MY_UID() == 0);
1211
1212         memset(&stats, 0, sizeof(stats));
1213
1214         if (argc < 2) {
1215                 usage(FERROR);
1216                 exit_cleanup(RERR_SYNTAX);
1217         }
1218
1219         /* we set a 0 umask so that correct file permissions can be
1220          * carried across */
1221         orig_umask = umask(0);
1222
1223 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1224         setlocale(LC_CTYPE, "");
1225 #endif
1226
1227         if (!parse_arguments(&argc, (const char ***) &argv, 1)) {
1228                 /* FIXME: We ought to call the same error-handling
1229                  * code here, rather than relying on getopt. */
1230                 option_error();
1231                 exit_cleanup(RERR_SYNTAX);
1232         }
1233
1234         SIGACTMASK(SIGINT, sig_int);
1235         SIGACTMASK(SIGHUP, sig_int);
1236         SIGACTMASK(SIGTERM, sig_int);
1237 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1238         sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1239 #endif
1240
1241         /* Ignore SIGPIPE; we consistently check error codes and will
1242          * see the EPIPE. */
1243         SIGACTION(SIGPIPE, SIG_IGN);
1244 #ifdef SIGXFSZ
1245         SIGACTION(SIGXFSZ, SIG_IGN);
1246 #endif
1247
1248         /* Initialize push_dir here because on some old systems getcwd
1249          * (implemented by forking "pwd" and reading its output) doesn't
1250          * work when there are other child processes.  Also, on all systems
1251          * that implement getcwd that way "pwd" can't be found after chroot. */
1252         push_dir(NULL);
1253
1254         init_flist();
1255
1256         if ((write_batch || read_batch) && !am_server) {
1257                 if (write_batch)
1258                         write_batch_shell_file(orig_argc, orig_argv, argc);
1259
1260                 if (read_batch && strcmp(batch_name, "-") == 0)
1261                         batch_fd = STDIN_FILENO;
1262                 else {
1263                         batch_fd = do_open(batch_name,
1264                                    write_batch ? O_WRONLY | O_CREAT | O_TRUNC
1265                                    : O_RDONLY, S_IRUSR | S_IWUSR);
1266                 }
1267                 if (batch_fd < 0) {
1268                         rsyserr(FERROR, errno, "Batch file %s open error",
1269                                 full_fname(batch_name));
1270                         exit_cleanup(RERR_FILEIO);
1271                 }
1272                 if (read_batch)
1273                         read_stream_flags(batch_fd);
1274         }
1275         if (write_batch < 0)
1276                 dry_run = 1;
1277
1278         if (am_daemon && !am_server)
1279                 return daemon_main();
1280
1281         if (argc < 1) {
1282                 usage(FERROR);
1283                 exit_cleanup(RERR_SYNTAX);
1284         }
1285
1286         if (am_server) {
1287                 set_nonblocking(STDIN_FILENO);
1288                 set_nonblocking(STDOUT_FILENO);
1289                 if (am_daemon)
1290                         return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1291                 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1292         }
1293
1294         ret = start_client(argc, argv);
1295         if (ret == -1)
1296                 exit_cleanup(RERR_STARTCLIENT);
1297         else
1298                 exit_cleanup(ret);
1299
1300         return ret;
1301 }