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