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_excluded;
  37 extern int delete_after;
  38 extern int daemon_over_rsh;
  39 extern int do_stats;
  40 extern int dry_run;
  41 extern int list_only;
  42 extern int local_server;
  43 extern int log_got_error;
  44 extern int module_id;
  45 extern int orig_umask;
  46 extern int copy_links;
  47 extern int keep_dirlinks;
  48 extern int preserve_hard_links;
  49 extern int protocol_version;
  50 extern int recurse;
  51 extern int relative_paths;
  52 extern int rsync_port;
  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 char *files_from;
  61 extern char *remote_filesfrom_file;
  62 extern char *basis_dir[];
  63 extern char *rsync_path;
  64 extern char *shell_cmd;
  65 extern char *batch_name;
  66
  67
  68 /* there's probably never more than at most 2 outstanding child processes,
  69  * but set it higher just in case.
  70  */
  71 #define MAXCHILDPROCS 5
  72
  73 struct pid_status {
  74         pid_t pid;
  75         int   status;
  76 } pid_stat_table[MAXCHILDPROCS];
  77
  78 static void show_malloc_stats(void);
  79
  80 /****************************************************************************
  81 wait for a process to exit, calling io_flush while waiting
  82 ****************************************************************************/
  83 void wait_process(pid_t pid, int *status)
  84 {
  85         pid_t waited_pid;
  86         int cnt;
  87
  88         while ((waited_pid = waitpid(pid, status, WNOHANG)) == 0) {
  89                 msleep(20);
  90                 io_flush(FULL_FLUSH);
  91         }
  92
  93         if (waited_pid == -1 && errno == ECHILD) {
  94                 /* status of requested child no longer available.
  95                  * check to see if it was processed by the sigchld_handler.
  96                  */
  97                 for (cnt = 0;  cnt < MAXCHILDPROCS; cnt++) {
  98                         if (pid == pid_stat_table[cnt].pid) {
  99                                 *status = pid_stat_table[cnt].status;
 100                                 pid_stat_table[cnt].pid = 0;
 101                                 break;
 102                         }
 103                 }
 104         }
 105
 106         /* TODO: If the child exited on a signal, then log an
 107          * appropriate error message.  Perhaps we should also accept a
 108          * message describing the purpose of the child.  Also indicate
 109          * this to the caller so that thhey know something went
 110          * wrong.  */
 111         *status = WEXITSTATUS(*status);
 112 }
 113
 114 /* This function gets called from all 3 processes.  We want the client side
 115  * to actually output the text, but the sender is the only process that has
 116  * all the stats we need.  So, if we're a client sender, we do the report.
 117  * If we're a server sender, we write the stats on the supplied fd.  If
 118  * we're the client receiver we read the stats from the supplied fd and do
 119  * the report.  All processes might also generate a set of debug stats, if
 120  * the verbose level is high enough (this is the only thing that the
 121  * generator process and the server receiver ever do here). */
 122 static void report(int f)
 123 {
 124         /* Cache two stats because the read/write code can change it. */
 125         int64 total_read = stats.total_read;
 126         int64 total_written = stats.total_written;
 127         time_t t = time(NULL);
 128
 129         if (do_stats && verbose > 1) {
 130                 /* These come out from every process */
 131                 show_malloc_stats();
 132                 show_flist_stats();
 133         }
 134
 135         if (am_generator)
 136                 return;
 137
 138         if (am_daemon) {
 139                 log_exit(0, __FILE__, __LINE__);
 140                 if (f == -1 || !am_sender)
 141                         return;
 142         }
 143
 144         if (am_server) {
 145                 if (am_sender) {
 146                         write_longint(f, total_read);
 147                         write_longint(f, total_written);
 148                         write_longint(f, stats.total_size);
 149                 }
 150                 return;
 151         }
 152
 153         /* this is the client */
 154
 155         if (!am_sender) {
 156                 /* Read the first two in opposite order because the meaning of
 157                  * read/write swaps when switching from sender to receiver. */
 158                 total_written = read_longint(f);
 159                 total_read = read_longint(f);
 160                 stats.total_size = read_longint(f);
 161         } else if (write_batch) {
 162                 /* The --read-batch process is going to be a client
 163                  * receiver, so we need to give it the stats. */
 164                 write_longint(batch_fd, total_read);
 165                 write_longint(batch_fd, total_written);
 166                 write_longint(batch_fd, stats.total_size);
 167         }
 168
 169         if (do_stats) {
 170                 rprintf(FINFO,"\nNumber of files: %d\n", stats.num_files);
 171                 rprintf(FINFO,"Number of files transferred: %d\n",
 172                         stats.num_transferred_files);
 173                 rprintf(FINFO,"Total file size: %.0f bytes\n",
 174                         (double)stats.total_size);
 175                 rprintf(FINFO,"Total transferred file size: %.0f bytes\n",
 176                         (double)stats.total_transferred_size);
 177                 rprintf(FINFO,"Literal data: %.0f bytes\n",
 178                         (double)stats.literal_data);
 179                 rprintf(FINFO,"Matched data: %.0f bytes\n",
 180                         (double)stats.matched_data);
 181                 rprintf(FINFO,"File list size: %d\n", stats.flist_size);
 182                 rprintf(FINFO,"Total bytes sent: %.0f\n",
 183                         (double)total_written);
 184                 rprintf(FINFO,"Total bytes received: %.0f\n",
 185                         (double)total_read);
 186         }
 187
 188         if (verbose || do_stats) {
 189                 rprintf(FINFO,
 190                         "\nsent %.0f bytes  received %.0f bytes  %.2f bytes/sec\n",
 191                         (double)total_written, (double)total_read,
 192                         (total_written + total_read)/(0.5 + (t - starttime)));
 193                 rprintf(FINFO, "total size is %.0f  speedup is %.2f\n",
 194                         (double)stats.total_size,
 195                         (double)stats.total_size / (total_written+total_read));
 196         }
 197
 198         fflush(stdout);
 199         fflush(stderr);
 200 }
 201
 202
 203 /**
 204  * If our C library can get malloc statistics, then show them to FINFO
 205  **/
 206 static void show_malloc_stats(void)
 207 {
 208 #ifdef HAVE_MALLINFO
 209         struct mallinfo mi;
 210
 211         mi = mallinfo();
 212
 213         rprintf(FINFO, "\n" RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
 214                 getpid(),
 215                 am_server ? "server " : "",
 216                 am_daemon ? "daemon " : "",
 217                 who_am_i());
 218         rprintf(FINFO, "  arena:     %10d   (bytes from sbrk)\n", mi.arena);
 219         rprintf(FINFO, "  ordblks:   %10d   (chunks not in use)\n", mi.ordblks);
 220         rprintf(FINFO, "  smblks:    %10d\n", mi.smblks);
 221         rprintf(FINFO, "  hblks:     %10d   (chunks from mmap)\n", mi.hblks);
 222         rprintf(FINFO, "  hblkhd:    %10d   (bytes from mmap)\n", mi.hblkhd);
 223         rprintf(FINFO, "  allmem:    %10d   (bytes from sbrk + mmap)\n",
 224             mi.arena + mi.hblkhd);
 225         rprintf(FINFO, "  usmblks:   %10d\n", mi.usmblks);
 226         rprintf(FINFO, "  fsmblks:   %10d\n", mi.fsmblks);
 227         rprintf(FINFO, "  uordblks:  %10d   (bytes used)\n", mi.uordblks);
 228         rprintf(FINFO, "  fordblks:  %10d   (bytes free)\n", mi.fordblks);
 229         rprintf(FINFO, "  keepcost:  %10d   (bytes in releasable chunk)\n", mi.keepcost);
 230 #endif /* HAVE_MALLINFO */
 231 }
 232
 233
 234 /* Start the remote shell.   cmd may be NULL to use the default. */
 235 static pid_t do_cmd(char *cmd, char *machine, char *user, char *path,
 236                     int *f_in, int *f_out)
 237 {
 238         int i, argc = 0;
 239         char *args[MAX_ARGS];
 240         pid_t ret;
 241         char *tok, *dir = NULL;
 242         int dash_l_set = 0;
 243
 244         if (!read_batch && !local_server) {
 245                 char *rsh_env = getenv(RSYNC_RSH_ENV);
 246                 if (!cmd)
 247                         cmd = rsh_env;
 248                 if (!cmd)
 249                         cmd = RSYNC_RSH;
 250                 cmd = strdup(cmd);
 251                 if (!cmd)
 252                         goto oom;
 253
 254                 for (tok = strtok(cmd, " "); tok; tok = strtok(NULL, " ")) {
 255                         /* Comparison leaves rooms for server_options(). */
 256                         if (argc >= MAX_ARGS - 100) {
 257                                 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
 258                                 exit_cleanup(RERR_SYNTAX);
 259                         }
 260                         args[argc++] = tok;
 261                 }
 262
 263                 /* check to see if we've already been given '-l user' in
 264                  * the remote-shell command */
 265                 for (i = 0; i < argc-1; i++) {
 266                         if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
 267                                 dash_l_set = 1;
 268                 }
 269
 270 #if HAVE_REMSH
 271                 /* remsh (on HPUX) takes the arguments the other way around */
 272                 args[argc++] = machine;
 273                 if (user && !(daemon_over_rsh && dash_l_set)) {
 274                         args[argc++] = "-l";
 275                         args[argc++] = user;
 276                 }
 277 #else
 278                 if (user && !(daemon_over_rsh && dash_l_set)) {
 279                         args[argc++] = "-l";
 280                         args[argc++] = user;
 281                 }
 282                 args[argc++] = machine;
 283 #endif
 284
 285                 args[argc++] = rsync_path;
 286
 287                 if (blocking_io < 0) {
 288                         char *cp;
 289                         if ((cp = strrchr(cmd, '/')) != NULL)
 290                                 cp++;
 291                         else
 292                                 cp = cmd;
 293                         if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
 294                                 blocking_io = 1;
 295                 }
 296
 297                 server_options(args,&argc);
 298
 299                 if (argc >= MAX_ARGS - 2) {
 300                         rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
 301                         exit_cleanup(RERR_SYNTAX);
 302                 }
 303         }
 304
 305         args[argc++] = ".";
 306
 307         if (!daemon_over_rsh && path && *path)
 308                 args[argc++] = path;
 309
 310         args[argc] = NULL;
 311
 312         if (verbose > 3) {
 313                 rprintf(FINFO,"cmd=");
 314                 for (i = 0; i < argc; i++)
 315                         rprintf(FINFO,"%s ",args[i]);
 316                 rprintf(FINFO,"\n");
 317         }
 318
 319         if (read_batch) {
 320                 int from_gen_pipe[2];
 321                 if (fd_pair(from_gen_pipe) < 0) {
 322                         rsyserr(FERROR, errno, "pipe");
 323                         exit_cleanup(RERR_IPC);
 324                 }
 325                 batch_gen_fd = from_gen_pipe[0];
 326                 *f_out = from_gen_pipe[1];
 327                 *f_in = batch_fd;
 328                 ret = -1; /* no child pid */
 329         } else if (local_server) {
 330                 /* If the user didn't request --[no-]whole-file, force
 331                  * it on, but only if we're not batch processing. */
 332                 if (whole_file < 0 && !write_batch)
 333                         whole_file = 1;
 334                 ret = local_child(argc, args, f_in, f_out, child_main);
 335         } else
 336                 ret = piped_child(args,f_in,f_out);
 337
 338         if (dir)
 339                 free(dir);
 340
 341         return ret;
 342
 343 oom:
 344         out_of_memory("do_cmd");
 345         return 0; /* not reached */
 346 }
 347
 348
 349 static char *get_local_name(struct file_list *flist,char *name)
 350 {
 351         STRUCT_STAT st;
 352         int e;
 353
 354         if (verbose > 2)
 355                 rprintf(FINFO,"get_local_name count=%d %s\n",
 356                         flist->count, NS(name));
 357
 358         if (!name)
 359                 return NULL;
 360
 361         if (do_stat(name,&st) == 0) {
 362                 if (S_ISDIR(st.st_mode)) {
 363                         if (!push_dir(name)) {
 364                                 rsyserr(FERROR, errno, "push_dir#1 %s failed",
 365                                         full_fname(name));
 366                                 exit_cleanup(RERR_FILESELECT);
 367                         }
 368                         return NULL;
 369                 }
 370                 if (flist->count > 1) {
 371                         rprintf(FERROR,"ERROR: destination must be a directory when copying more than 1 file\n");
 372                         exit_cleanup(RERR_FILESELECT);
 373                 }
 374                 return name;
 375         }
 376
 377         if (flist->count <= 1 && ((e = strlen(name)) <= 1 || name[e-1] != '/'))
 378                 return name;
 379
 380         if (do_mkdir(name,0777 & ~orig_umask) != 0) {
 381                 rsyserr(FERROR, errno, "mkdir %s failed", full_fname(name));
 382                 exit_cleanup(RERR_FILEIO);
 383         }
 384         if (verbose > 0)
 385                 rprintf(FINFO, "created directory %s\n", name);
 386
 387         if (dry_run) {
 388                 dry_run++;
 389                 return NULL;
 390         }
 391
 392         if (!push_dir(name)) {
 393                 rsyserr(FERROR, errno, "push_dir#2 %s failed",
 394                         full_fname(name));
 395                 exit_cleanup(RERR_FILESELECT);
 396         }
 397
 398         return NULL;
 399 }
 400
 401
 402 static void do_server_sender(int f_in, int f_out, int argc,char *argv[])
 403 {
 404         int i;
 405         struct file_list *flist;
 406         char *dir = argv[0];
 407
 408         if (verbose > 2) {
 409                 rprintf(FINFO, "server_sender starting pid=%ld\n",
 410                         (long)getpid());
 411         }
 412
 413         if (am_daemon && lp_write_only(module_id)) {
 414                 rprintf(FERROR, "ERROR: module is write only\n");
 415                 exit_cleanup(RERR_SYNTAX);
 416                 return;
 417         }
 418
 419         if (!relative_paths && !push_dir(dir)) {
 420                 rsyserr(FERROR, errno, "push_dir#3 %s failed",
 421                         full_fname(dir));
 422                 exit_cleanup(RERR_FILESELECT);
 423         }
 424         argc--;
 425         argv++;
 426
 427         if (strcmp(dir,".")) {
 428                 int l = strlen(dir);
 429                 if (strcmp(dir,"/") == 0)
 430                         l = 0;
 431                 for (i = 0; i < argc; i++)
 432                         argv[i] += l+1;
 433         }
 434
 435         if (argc == 0 && recurse) {
 436                 argc = 1;
 437                 argv--;
 438                 argv[0] = ".";
 439         }
 440
 441         flist = send_file_list(f_out,argc,argv);
 442         if (!flist || flist->count == 0) {
 443                 exit_cleanup(0);
 444         }
 445
 446         io_start_buffering_in();
 447         io_start_buffering_out();
 448
 449         send_files(flist,f_out,f_in);
 450         io_flush(FULL_FLUSH);
 451         report(f_out);
 452         if (protocol_version >= 24) {
 453                 /* final goodbye message */
 454                 read_int(f_in);
 455         }
 456         io_flush(FULL_FLUSH);
 457         exit_cleanup(0);
 458 }
 459
 460
 461 static int do_recv(int f_in,int f_out,struct file_list *flist,char *local_name)
 462 {
 463         int pid;
 464         int status = 0;
 465         int error_pipe[2], name_pipe[2];
 466         BOOL need_name_pipe = basis_dir[0] && !dry_run;
 467
 468         /* The receiving side mustn't obey this, or an existing symlink that
 469          * points to an identical file won't be replaced by the referent. */
 470         copy_links = 0;
 471
 472         if (preserve_hard_links)
 473                 init_hard_links(flist);
 474
 475         if (!delete_after) {
 476                 /* I moved this here from recv_files() to prevent a race condition */
 477                 if (recurse && delete_mode && !local_name && flist->count > 0)
 478                         delete_files(flist);
 479         }
 480
 481         if (fd_pair(error_pipe) < 0
 482             || (need_name_pipe && fd_pair(name_pipe) < 0)) {
 483                 rsyserr(FERROR, errno, "pipe failed in do_recv");
 484                 exit_cleanup(RERR_IPC);
 485         }
 486
 487         io_flush(NORMAL_FLUSH);
 488
 489         if ((pid = do_fork()) == -1) {
 490                 rsyserr(FERROR, errno, "fork failed in do_recv");
 491                 exit_cleanup(RERR_IPC);
 492         }
 493
 494         if (pid == 0) {
 495                 close(error_pipe[0]);
 496                 if (need_name_pipe) {
 497                         close(name_pipe[1]);
 498                         set_blocking(name_pipe[0]);
 499                 } else
 500                         name_pipe[0] = -1;
 501                 if (f_in != f_out)
 502                         close(f_out);
 503
 504                 /* we can't let two processes write to the socket at one time */
 505                 close_multiplexing_out();
 506
 507                 /* set place to send errors */
 508                 set_msg_fd_out(error_pipe[1]);
 509
 510                 recv_files(f_in, flist, local_name, name_pipe[0]);
 511                 io_flush(FULL_FLUSH);
 512                 report(f_in);
 513
 514                 send_msg(MSG_DONE, "", 0);
 515                 io_flush(FULL_FLUSH);
 516                 /* finally we go to sleep until our parent kills us
 517                  * with a USR2 signal. We sleep for a short time as on
 518                  * some OSes a signal won't interrupt a sleep! */
 519                 while (1)
 520                         msleep(20);
 521         }
 522
 523         am_generator = 1;
 524         close_multiplexing_in();
 525         if (write_batch)
 526                 stop_write_batch();
 527
 528         close(error_pipe[1]);
 529         if (need_name_pipe) {
 530                 close(name_pipe[0]);
 531                 set_nonblocking(name_pipe[1]);
 532         } else
 533                 name_pipe[1] = -1;
 534         if (f_in != f_out)
 535                 close(f_in);
 536
 537         io_start_buffering_out();
 538
 539         set_msg_fd_in(error_pipe[0]);
 540
 541         generate_files(f_out, flist, local_name, name_pipe[1]);
 542
 543         get_redo_num(); /* Read final MSG_DONE and any prior messages. */
 544         report(-1);
 545         io_flush(FULL_FLUSH);
 546         if (protocol_version >= 24) {
 547                 /* send a final goodbye message */
 548                 write_int(f_out, -1);
 549         }
 550         io_flush(FULL_FLUSH);
 551
 552         set_msg_fd_in(-1);
 553         kill(pid, SIGUSR2);
 554         wait_process(pid, &status);
 555         return status;
 556 }
 557
 558
 559 static void do_server_recv(int f_in, int f_out, int argc,char *argv[])
 560 {
 561         int status;
 562         struct file_list *flist;
 563         char *local_name = NULL;
 564         char *dir = NULL;
 565         int save_verbose = verbose;
 566
 567         if (filesfrom_fd >= 0) {
 568                 /* We can't mix messages with files-from data on the socket,
 569                  * so temporarily turn off verbose messages. */
 570                 verbose = 0;
 571         }
 572
 573         if (verbose > 2) {
 574                 rprintf(FINFO, "server_recv(%d) starting pid=%ld\n",
 575                         argc, (long)getpid());
 576         }
 577
 578         if (am_daemon && lp_read_only(module_id)) {
 579                 rprintf(FERROR,"ERROR: module is read only\n");
 580                 exit_cleanup(RERR_SYNTAX);
 581                 return;
 582         }
 583
 584
 585         if (argc > 0) {
 586                 dir = argv[0];
 587                 argc--;
 588                 argv++;
 589                 if (!am_daemon && !push_dir(dir)) {
 590                         rsyserr(FERROR, errno, "push_dir#4 %s failed",
 591                                 full_fname(dir));
 592                         exit_cleanup(RERR_FILESELECT);
 593                 }
 594         }
 595
 596         io_start_buffering_in();
 597         if (delete_mode && !delete_excluded)
 598                 recv_exclude_list(f_in);
 599
 600         if (filesfrom_fd >= 0) {
 601                 /* We need to send the files-from names to the sender at the
 602                  * same time that we receive the file-list from them, so we
 603                  * need the IO routines to automatically write out the names
 604                  * onto our f_out socket as we read the file-list.  This
 605                  * avoids both deadlock and extra delays/buffers. */
 606                 io_set_filesfrom_fds(filesfrom_fd, f_out);
 607                 filesfrom_fd = -1;
 608         }
 609
 610         flist = recv_file_list(f_in);
 611         verbose = save_verbose;
 612         if (!flist) {
 613                 rprintf(FERROR,"server_recv: recv_file_list error\n");
 614                 exit_cleanup(RERR_FILESELECT);
 615         }
 616
 617         if (argc > 0) {
 618                 if (strcmp(dir,".")) {
 619                         argv[0] += strlen(dir);
 620                         if (argv[0][0] == '/')
 621                                 argv[0]++;
 622                 }
 623                 local_name = get_local_name(flist,argv[0]);
 624         }
 625
 626         status = do_recv(f_in,f_out,flist,local_name);
 627         exit_cleanup(status);
 628 }
 629
 630
 631 int child_main(int argc, char *argv[])
 632 {
 633         start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
 634         return 0;
 635 }
 636
 637
 638 void start_server(int f_in, int f_out, int argc, char *argv[])
 639 {
 640         set_nonblocking(f_in);
 641         set_nonblocking(f_out);
 642
 643         io_set_sock_fds(f_in, f_out);
 644         setup_protocol(f_out, f_in);
 645
 646         if (protocol_version >= 23)
 647                 io_start_multiplex_out();
 648
 649         if (am_sender) {
 650                 keep_dirlinks = 0; /* Must be disabled on the sender. */
 651
 652                 recv_exclude_list(f_in);
 653                 if (cvs_exclude)
 654                         add_cvs_excludes();
 655                 do_server_sender(f_in, f_out, argc, argv);
 656         } else {
 657                 do_server_recv(f_in, f_out, argc, argv);
 658         }
 659         exit_cleanup(0);
 660 }
 661
 662
 663 /*
 664  * This is called once the connection has been negotiated.  It is used
 665  * for rsyncd, remote-shell, and local connections.
 666  */
 667 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
 668 {
 669         struct file_list *flist = NULL;
 670         int status = 0, status2 = 0;
 671         char *local_name = NULL;
 672
 673         cleanup_child_pid = pid;
 674         if (read_batch) {
 675                 assert(am_sender == 0);
 676         } else {
 677                 set_nonblocking(f_in);
 678                 set_nonblocking(f_out);
 679         }
 680
 681         io_set_sock_fds(f_in, f_out);
 682         setup_protocol(f_out,f_in);
 683
 684         if (protocol_version >= 23 && !read_batch)
 685                 io_start_multiplex_in();
 686
 687         /* We set our stderr file handle to blocking because ssh might have
 688          * set it to non-blocking.  This can be particularly troublesome if
 689          * stderr is a clone of stdout, because ssh would have set our stdout
 690          * to non-blocking at the same time (which can easily cause us to lose
 691          * output from our print statements).  This kluge shouldn't cause ssh
 692          * any problems for how we use it.  Note also that we delayed setting
 693          * this until after the above protocol setup so that we know for sure
 694          * that ssh is done twiddling its file descriptors.  */
 695         set_blocking(STDERR_FILENO);
 696
 697         if (am_sender) {
 698                 keep_dirlinks = 0; /* Must be disabled on the sender. */
 699                 io_start_buffering_out();
 700                 if (!remote_filesfrom_file)
 701                         set_msg_fd_in(f_in);
 702                 if (cvs_exclude)
 703                         add_cvs_excludes();
 704                 if (delete_mode && !delete_excluded)
 705                         send_exclude_list(f_out);
 706                 if (remote_filesfrom_file)
 707                         filesfrom_fd = f_in;
 708
 709                 if (write_batch)
 710                         start_write_batch(f_out);
 711                 if (!read_batch) /* don't write to pipe */
 712                         flist = send_file_list(f_out,argc,argv);
 713                 set_msg_fd_in(-1);
 714                 if (verbose > 3)
 715                         rprintf(FINFO,"file list sent\n");
 716
 717                 io_flush(NORMAL_FLUSH);
 718                 send_files(flist,f_out,f_in);
 719                 io_flush(FULL_FLUSH);
 720                 if (protocol_version >= 24) {
 721                         /* final goodbye message */
 722                         read_int(f_in);
 723                 }
 724                 if (pid != -1) {
 725                         if (verbose > 3)
 726                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
 727                         io_flush(FULL_FLUSH);
 728                         wait_process(pid, &status);
 729                 }
 730                 report(-1);
 731                 io_flush(FULL_FLUSH);
 732                 exit_cleanup(status);
 733         }
 734
 735         if (argc == 0)
 736                 list_only = 1;
 737
 738         if (!read_batch)
 739                 send_exclude_list(f_out);
 740
 741         if (filesfrom_fd >= 0) {
 742                 io_set_filesfrom_fds(filesfrom_fd, f_out);
 743                 filesfrom_fd = -1;
 744         }
 745
 746         if (write_batch)
 747                 start_write_batch(f_in);
 748         flist = recv_file_list(f_in);
 749         if (!flist || flist->count == 0) {
 750                 rprintf(FINFO, "client: nothing to do: "
 751                         "perhaps you need to specify some filenames or "
 752                         "the --recursive option?\n");
 753                 exit_cleanup(0);
 754         }
 755
 756         local_name = get_local_name(flist,argv[0]);
 757
 758         status2 = do_recv(f_in,f_out,flist,local_name);
 759
 760         if (pid != -1) {
 761                 if (verbose > 3)
 762                         rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
 763                 io_flush(FULL_FLUSH);
 764                 wait_process(pid, &status);
 765         }
 766
 767         return MAX(status, status2);
 768 }
 769
 770 static int copy_argv (char *argv[])
 771 {
 772         int i;
 773
 774         for (i = 0; argv[i]; i++) {
 775                 if (!(argv[i] = strdup(argv[i]))) {
 776                         rprintf (FERROR, "out of memory at %s(%d)\n",
 777                                  __FILE__, __LINE__);
 778                         return RERR_MALLOC;
 779                 }
 780         }
 781
 782         return 0;
 783 }
 784
 785
 786 /**
 787  * Start a client for either type of remote connection.  Work out
 788  * whether the arguments request a remote shell or rsyncd connection,
 789  * and call the appropriate connection function, then run_client.
 790  *
 791  * Calls either start_socket_client (for sockets) or do_cmd and
 792  * client_run (for ssh).
 793  **/
 794 static int start_client(int argc, char *argv[])
 795 {
 796         char *p;
 797         char *shell_machine = NULL;
 798         char *shell_path = NULL;
 799         char *shell_user = NULL;
 800         int ret;
 801         pid_t pid;
 802         int f_in,f_out;
 803         int rc;
 804
 805         /* Don't clobber argv[] so that ps(1) can still show the right
 806          * command line. */
 807         if ((rc = copy_argv(argv)))
 808                 return rc;
 809
 810         /* rsync:// always uses rsync server over direct socket connection */
 811         if (strncasecmp(URL_PREFIX, argv[0], strlen(URL_PREFIX)) == 0
 812             && !read_batch) {
 813                 char *host, *path;
 814
 815                 host = argv[0] + strlen(URL_PREFIX);
 816                 p = strchr(host,'/');
 817                 if (p) {
 818                         *p = '\0';
 819                         path = p+1;
 820                 } else
 821                         path = "";
 822                 if (*host == '[' && (p = strchr(host, ']')) != NULL) {
 823                         host++;
 824                         *p++ = '\0';
 825                         if (*p != ':')
 826                                 p = NULL;
 827                 } else
 828                         p = strchr(host, ':');
 829                 if (p) {
 830                         rsync_port = atoi(p+1);
 831                         *p = '\0';
 832                 } else
 833                         rsync_port = RSYNC_PORT;
 834                 return start_socket_client(host, path, argc-1, argv+1);
 835         }
 836
 837         if (!read_batch) { /* for read_batch, NO source is specified */
 838                 p = find_colon(argv[0]);
 839                 if (p) { /* source is remote */
 840                         if (remote_filesfrom_file
 841                          && remote_filesfrom_file != files_from + 1
 842                          && strncmp(files_from, argv[0], p-argv[0]+1) != 0) {
 843                                 rprintf(FERROR,
 844                                         "--files-from hostname is not the same as the transfer hostname\n");
 845                                 exit_cleanup(RERR_SYNTAX);
 846                         }
 847                         if (p[1] == ':') { /* double colon */
 848                                 *p = 0;
 849                                 if (!shell_cmd) {
 850                                         return start_socket_client(argv[0], p+2,
 851                                                                    argc-1, argv+1);
 852                                 }
 853                                 p++;
 854                                 daemon_over_rsh = 1;
 855                         }
 856
 857                         if (argc < 1) { /* destination required */
 858                                 usage(FERROR);
 859                                 exit_cleanup(RERR_SYNTAX);
 860                         }
 861
 862                         am_sender = 0;
 863                         *p = 0;
 864                         shell_machine = argv[0];
 865                         shell_path = p+1;
 866                         argv++;
 867                 } else { /* source is local */
 868                         am_sender = 1;
 869
 870                         /* rsync:// destination uses rsync server over direct socket */
 871                         if (strncasecmp(URL_PREFIX, argv[argc-1], strlen(URL_PREFIX)) == 0) {
 872                                 char *host, *path;
 873
 874                                 host = argv[argc-1] + strlen(URL_PREFIX);
 875                                 p = strchr(host,'/');
 876                                 if (p) {
 877                                         *p = '\0';
 878                                         path = p+1;
 879                                 } else
 880                                         path = "";
 881                                 if (*host == '[' && (p = strchr(host, ']')) != NULL) {
 882                                         host++;
 883                                         *p++ = '\0';
 884                                         if (*p != ':')
 885                                                 p = NULL;
 886                                 } else
 887                                         p = strchr(host, ':');
 888                                 if (p) {
 889                                         rsync_port = atoi(p+1);
 890                                         *p = '\0';
 891                                 } else
 892                                         rsync_port = RSYNC_PORT;
 893                                 return start_socket_client(host, path, argc-1, argv);
 894                         }
 895
 896                         p = find_colon(argv[argc-1]); /* look in dest arg */
 897                         if (p && remote_filesfrom_file
 898                          && remote_filesfrom_file != files_from + 1
 899                          && strncmp(files_from, argv[argc-1], p-argv[argc-1]+1) != 0) {
 900                                 rprintf(FERROR,
 901                                         "--files-from hostname is not the same as the transfer hostname\n");
 902                                 exit_cleanup(RERR_SYNTAX);
 903                         }
 904                         if (!p) { /* no colon found, so src & dest are local */
 905                                 local_server = 1;
 906                                 if (remote_filesfrom_file) {
 907                                         rprintf(FERROR,
 908                                                 "--files-from cannot be remote when the transfer is local\n");
 909                                         exit_cleanup(RERR_SYNTAX);
 910                                 }
 911                         } else if (p[1] == ':') { /* double colon */
 912                                 *p = 0;
 913                                 if (!shell_cmd) {
 914                                         return start_socket_client(argv[argc-1], p+2,
 915                                                                    argc-1, argv);
 916                                 }
 917                                 p++;
 918                                 daemon_over_rsh = 1;
 919                         }
 920
 921                         if (argc < 2) {
 922                                 usage(FERROR);
 923                                 exit_cleanup(RERR_SYNTAX);
 924                         }
 925
 926                         if (local_server) {
 927                                 shell_machine = NULL;
 928                                 shell_path = argv[argc-1];
 929                         } else {
 930                                 *p = 0;
 931                                 shell_machine = argv[argc-1];
 932                                 shell_path = p+1;
 933                         }
 934                 }
 935                 argc--;
 936         } else {  /* read_batch */
 937                 local_server = 1;
 938                 shell_path = argv[argc-1];
 939                 if (find_colon(shell_path)) {
 940                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
 941                         exit_cleanup(RERR_SYNTAX);
 942                 }
 943         }
 944
 945         if (shell_machine) {
 946                 p = strrchr(shell_machine,'@');
 947                 if (p) {
 948                         *p = 0;
 949                         shell_user = shell_machine;
 950                         shell_machine = p+1;
 951                 }
 952         }
 953
 954         if (verbose > 3) {
 955                 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
 956                         shell_cmd?shell_cmd:"",
 957                         shell_machine?shell_machine:"",
 958                         shell_user?shell_user:"",
 959                         shell_path?shell_path:"");
 960         }
 961
 962         /* for remote source, only single dest arg can remain ... */
 963         if (!am_sender && argc > 1) {
 964                 usage(FERROR);
 965                 exit_cleanup(RERR_SYNTAX);
 966         }
 967
 968         /* ... or no dest at all */
 969         if (!am_sender && argc == 0) {
 970                 list_only = 1;
 971         }
 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 }