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