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