main.c

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