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