main.c

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