main.c

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