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