main.c

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