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