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