main.c

   1 /*
   2  * The startup routines, including main(), for rsync.
   3  *
   4  * Copyright (C) 1996-2001 Andrew Tridgell <tridge@samba.org>
   5  * Copyright (C) 1996 Paul Mackerras
   6  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
   7  * Copyright (C) 2003-2020 Wayne Davison
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, visit the http://fsf.org website.
  21  */
  22
  23 #include "rsync.h"
  24 #include "inums.h"
  25 #include "ifuncs.h"
  26 #include "io.h"
  27 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
  28 #include <locale.h>
  29 #endif
  30 #include <popt.h>
  31 #ifdef __TANDEM
  32 #include <floss.h(floss_execlp)>
  33 #endif
  34
  35 extern int dry_run;
  36 extern int list_only;
  37 extern int io_timeout;
  38 extern int am_root;
  39 extern int am_server;
  40 extern int am_sender;
  41 extern int am_daemon;
  42 extern int inc_recurse;
  43 extern int blocking_io;
  44 extern int always_checksum;
  45 extern int remove_source_files;
  46 extern int output_needs_newline;
  47 extern int called_from_signal_handler;
  48 extern int need_messages_from_generator;
  49 extern int kluge_around_eof;
  50 extern int got_xfer_error;
  51 extern int msgs2stderr;
  52 extern int module_id;
  53 extern int read_only;
  54 extern int copy_links;
  55 extern int copy_dirlinks;
  56 extern int copy_unsafe_links;
  57 extern int keep_dirlinks;
  58 extern int preserve_hard_links;
  59 extern int protocol_version;
  60 extern int mkpath_dest_arg;
  61 extern int file_total;
  62 extern int recurse;
  63 extern int xfer_dirs;
  64 extern int protect_args;
  65 extern int relative_paths;
  66 extern int sanitize_paths;
  67 extern int curr_dir_depth;
  68 extern int curr_dir_len;
  69 extern int module_id;
  70 extern int rsync_port;
  71 extern int whole_file;
  72 extern int read_batch;
  73 extern int write_batch;
  74 extern int batch_fd;
  75 extern int sock_f_in;
  76 extern int sock_f_out;
  77 extern int filesfrom_fd;
  78 extern int connect_timeout;
  79 extern int send_msgs_to_gen;
  80 extern dev_t filesystem_dev;
  81 extern pid_t cleanup_child_pid;
  82 extern size_t bwlimit_writemax;
  83 extern unsigned int module_dirlen;
  84 extern BOOL flist_receiving_enabled;
  85 extern BOOL want_progress_now;
  86 extern BOOL shutting_down;
  87 extern int backup_dir_len;
  88 extern int basis_dir_cnt;
  89 extern int default_af_hint;
  90 extern int stdout_format_has_i;
  91 extern struct stats stats;
  92 extern char *stdout_format;
  93 extern char *logfile_format;
  94 extern char *filesfrom_host;
  95 extern char *partial_dir;
  96 extern char *rsync_path;
  97 extern char *shell_cmd;
  98 extern char *password_file;
  99 extern char *backup_dir;
 100 extern char *copy_as;
 101 extern char *tmpdir;
 102 extern char curr_dir[MAXPATHLEN];
 103 extern char backup_dir_buf[MAXPATHLEN];
 104 extern char *basis_dir[MAX_BASIS_DIRS+1];
 105 extern struct file_list *first_flist;
 106 extern filter_rule_list daemon_filter_list;
 107
 108 uid_t our_uid;
 109 gid_t our_gid;
 110 int am_receiver = 0;  /* Only set to 1 after the receiver/generator fork. */
 111 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
 112 int local_server = 0;
 113 int daemon_connection = 0; /* 0 = no daemon, 1 = daemon via remote shell, -1 = daemon via socket */
 114 mode_t orig_umask = 0;
 115 int batch_gen_fd = -1;
 116 int sender_keeps_checksum = 0;
 117 int raw_argc, cooked_argc;
 118 char **raw_argv, **cooked_argv;
 119
 120 /* There's probably never more than at most 2 outstanding child processes,
 121  * but set it higher, just in case. */
 122 #define MAXCHILDPROCS 7
 123
 124 #ifdef HAVE_SIGACTION
 125 # ifdef HAVE_SIGPROCMASK
 126 #  define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
 127 # else
 128 #  define SIGACTMASK(n,h) SIGACTION(n,h)
 129 # endif
 130 static struct sigaction sigact;
 131 #endif
 132
 133 struct pid_status {
 134         pid_t pid;
 135         int status;
 136 } pid_stat_table[MAXCHILDPROCS];
 137
 138 static time_t starttime, endtime;
 139 static int64 total_read, total_written;
 140
 141 static void show_malloc_stats(void);
 142
 143 /* Works like waitpid(), but if we already harvested the child pid in our
 144  * remember_children(), we succeed instead of returning an error. */
 145 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
 146 {
 147         pid_t waited_pid;
 148
 149         do {
 150                 waited_pid = waitpid(pid, status_ptr, flags);
 151         } while (waited_pid == -1 && errno == EINTR);
 152
 153         if (waited_pid == -1 && errno == ECHILD) {
 154                 /* Status of requested child no longer available:  check to
 155                  * see if it was processed by remember_children(). */
 156                 int cnt;
 157                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
 158                         if (pid == pid_stat_table[cnt].pid) {
 159                                 *status_ptr = pid_stat_table[cnt].status;
 160                                 pid_stat_table[cnt].pid = 0;
 161                                 return pid;
 162                         }
 163                 }
 164         }
 165
 166         return waited_pid;
 167 }
 168
 169 int shell_exec(const char *cmd)
 170 {
 171         char *shell = getenv("RSYNC_SHELL");
 172         int status;
 173         pid_t pid;
 174
 175         if (!shell)
 176                 return system(cmd);
 177
 178         if ((pid = fork()) < 0)
 179                 return -1;
 180
 181         if (pid == 0) {
 182                 execlp(shell, shell, "-c", cmd, NULL);
 183                 _exit(1);
 184         }
 185
 186         int ret = wait_process(pid, &status, 0);
 187         return ret < 0 ? -1 : status;
 188 }
 189
 190 /* Wait for a process to exit, calling io_flush while waiting. */
 191 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
 192 {
 193         pid_t waited_pid;
 194         int status;
 195
 196         while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
 197                 msleep(20);
 198                 io_flush(FULL_FLUSH);
 199         }
 200
 201         /* TODO: If the child exited on a signal, then log an
 202          * appropriate error message.  Perhaps we should also accept a
 203          * message describing the purpose of the child.  Also indicate
 204          * this to the caller so that they know something went wrong. */
 205         if (waited_pid < 0) {
 206                 rsyserr(FERROR, errno, "waitpid");
 207                 *exit_code_ptr = RERR_WAITCHILD;
 208         } else if (!WIFEXITED(status)) {
 209 #ifdef WCOREDUMP
 210                 if (WCOREDUMP(status))
 211                         *exit_code_ptr = RERR_CRASHED;
 212                 else
 213 #endif
 214                 if (WIFSIGNALED(status))
 215                         *exit_code_ptr = RERR_TERMINATED;
 216                 else
 217                         *exit_code_ptr = RERR_WAITCHILD;
 218         } else
 219                 *exit_code_ptr = WEXITSTATUS(status);
 220 }
 221
 222 void write_del_stats(int f)
 223 {
 224         if (read_batch)
 225                 write_int(f, NDX_DEL_STATS);
 226         else
 227                 write_ndx(f, NDX_DEL_STATS);
 228         write_varint(f, stats.deleted_files - stats.deleted_dirs
 229                       - stats.deleted_symlinks - stats.deleted_devices
 230                       - stats.deleted_specials);
 231         write_varint(f, stats.deleted_dirs);
 232         write_varint(f, stats.deleted_symlinks);
 233         write_varint(f, stats.deleted_devices);
 234         write_varint(f, stats.deleted_specials);
 235 }
 236
 237 void read_del_stats(int f)
 238 {
 239         stats.deleted_files = read_varint(f);
 240         stats.deleted_files += stats.deleted_dirs = read_varint(f);
 241         stats.deleted_files += stats.deleted_symlinks = read_varint(f);
 242         stats.deleted_files += stats.deleted_devices = read_varint(f);
 243         stats.deleted_files += stats.deleted_specials = read_varint(f);
 244 }
 245
 246 static void become_copy_as_user()
 247 {
 248         char *gname;
 249         uid_t uid;
 250         gid_t gid;
 251
 252         if (!copy_as)
 253                 return;
 254
 255         if (DEBUG_GTE(CMD, 2))
 256                 rprintf(FINFO, "[%s] copy_as=%s\n", who_am_i(), copy_as);
 257
 258         if ((gname = strchr(copy_as, ':')) != NULL)
 259                 *gname++ = '\0';
 260
 261         if (!user_to_uid(copy_as, &uid, True)) {
 262                 rprintf(FERROR, "Invalid copy-as user: %s\n", copy_as);
 263                 exit_cleanup(RERR_SYNTAX);
 264         }
 265
 266         if (gname) {
 267                 if (!group_to_gid(gname, &gid, True)) {
 268                         rprintf(FERROR, "Invalid copy-as group: %s\n", gname);
 269                         exit_cleanup(RERR_SYNTAX);
 270                 }
 271         } else {
 272                 struct passwd *pw;
 273                 if ((pw = getpwuid(uid)) == NULL) {
 274                         rsyserr(FERROR, errno, "getpwuid failed");
 275                         exit_cleanup(RERR_SYNTAX);
 276                 }
 277                 gid = pw->pw_gid;
 278         }
 279
 280         if (setgid(gid) < 0) {
 281                 rsyserr(FERROR, errno, "setgid failed");
 282                 exit_cleanup(RERR_SYNTAX);
 283         }
 284 #ifdef HAVE_SETGROUPS
 285         if (setgroups(1, &gid)) {
 286                 rsyserr(FERROR, errno, "setgroups failed");
 287                 exit_cleanup(RERR_SYNTAX);
 288         }
 289 #endif
 290 #ifdef HAVE_INITGROUPS
 291         if (!gname && initgroups(copy_as, gid) < 0) {
 292                 rsyserr(FERROR, errno, "initgroups failed");
 293                 exit_cleanup(RERR_SYNTAX);
 294         }
 295 #endif
 296
 297         if (setuid(uid) < 0
 298 #ifdef HAVE_SETEUID
 299          || seteuid(uid) < 0
 300 #endif
 301         ) {
 302                 rsyserr(FERROR, errno, "setuid failed");
 303                 exit_cleanup(RERR_SYNTAX);
 304         }
 305
 306         our_uid = MY_UID();
 307         our_gid = MY_GID();
 308         am_root = (our_uid == ROOT_UID);
 309
 310         if (gname)
 311                 gname[-1] = ':';
 312 }
 313
 314 /* This function gets called from all 3 processes.  We want the client side
 315  * to actually output the text, but the sender is the only process that has
 316  * all the stats we need.  So, if we're a client sender, we do the report.
 317  * If we're a server sender, we write the stats on the supplied fd.  If
 318  * we're the client receiver we read the stats from the supplied fd and do
 319  * the report.  All processes might also generate a set of debug stats, if
 320  * the verbose level is high enough (this is the only thing that the
 321  * generator process and the server receiver ever do here). */
 322 static void handle_stats(int f)
 323 {
 324         endtime = time(NULL);
 325
 326         /* Cache two stats because the read/write code can change it. */
 327         total_read = stats.total_read;
 328         total_written = stats.total_written;
 329
 330         if (INFO_GTE(STATS, 3)) {
 331                 /* These come out from every process */
 332                 show_malloc_stats();
 333                 show_flist_stats();
 334         }
 335
 336         if (am_generator)
 337                 return;
 338
 339         if (am_daemon) {
 340                 if (f == -1 || !am_sender)
 341                         return;
 342         }
 343
 344         if (am_server) {
 345                 if (am_sender) {
 346                         write_varlong30(f, total_read, 3);
 347                         write_varlong30(f, total_written, 3);
 348                         write_varlong30(f, stats.total_size, 3);
 349                         if (protocol_version >= 29) {
 350                                 write_varlong30(f, stats.flist_buildtime, 3);
 351                                 write_varlong30(f, stats.flist_xfertime, 3);
 352                         }
 353                 }
 354                 return;
 355         }
 356
 357         /* this is the client */
 358
 359         if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
 360                 ;
 361         else if (!am_sender) {
 362                 /* Read the first two in opposite order because the meaning of
 363                  * read/write swaps when switching from sender to receiver. */
 364                 total_written = read_varlong30(f, 3);
 365                 total_read = read_varlong30(f, 3);
 366                 stats.total_size = read_varlong30(f, 3);
 367                 if (protocol_version >= 29) {
 368                         stats.flist_buildtime = read_varlong30(f, 3);
 369                         stats.flist_xfertime = read_varlong30(f, 3);
 370                 }
 371         } else if (write_batch) {
 372                 /* The --read-batch process is going to be a client
 373                  * receiver, so we need to give it the stats. */
 374                 write_varlong30(batch_fd, total_read, 3);
 375                 write_varlong30(batch_fd, total_written, 3);
 376                 write_varlong30(batch_fd, stats.total_size, 3);
 377                 if (protocol_version >= 29) {
 378                         write_varlong30(batch_fd, stats.flist_buildtime, 3);
 379                         write_varlong30(batch_fd, stats.flist_xfertime, 3);
 380                 }
 381         }
 382 }
 383
 384 static void output_itemized_counts(const char *prefix, int *counts)
 385 {
 386         static char *labels[] = { "reg", "dir", "link", "dev", "special" };
 387         char buf[1024], *pre = " (";
 388         int j, len = 0;
 389         int total = counts[0];
 390         if (total) {
 391                 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
 392                 for (j = 0; j < 5; j++) {
 393                         if (counts[j]) {
 394                                 len += snprintf(buf+len, sizeof buf - len - 2,
 395                                         "%s%s: %s",
 396                                         pre, labels[j], comma_num(counts[j]));
 397                                 pre = ", ";
 398                         }
 399                 }
 400                 buf[len++] = ')';
 401         }
 402         buf[len] = '\0';
 403         rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
 404 }
 405
 406 static const char *bytes_per_sec_human_dnum(void)
 407 {
 408         if (starttime == (time_t)-1 || endtime == (time_t)-1)
 409                 return "UNKNOWN";
 410         return human_dnum((total_written + total_read) / (0.5 + (endtime - starttime)), 2);
 411 }
 412
 413 static void output_summary(void)
 414 {
 415         if (INFO_GTE(STATS, 2)) {
 416                 rprintf(FCLIENT, "\n");
 417                 output_itemized_counts("Number of files", &stats.num_files);
 418                 if (protocol_version >= 29)
 419                         output_itemized_counts("Number of created files", &stats.created_files);
 420                 if (protocol_version >= 31)
 421                         output_itemized_counts("Number of deleted files", &stats.deleted_files);
 422                 rprintf(FINFO,"Number of regular files transferred: %s\n",
 423                         comma_num(stats.xferred_files));
 424                 rprintf(FINFO,"Total file size: %s bytes\n",
 425                         human_num(stats.total_size));
 426                 rprintf(FINFO,"Total transferred file size: %s bytes\n",
 427                         human_num(stats.total_transferred_size));
 428                 rprintf(FINFO,"Literal data: %s bytes\n",
 429                         human_num(stats.literal_data));
 430                 rprintf(FINFO,"Matched data: %s bytes\n",
 431                         human_num(stats.matched_data));
 432                 rprintf(FINFO,"File list size: %s\n",
 433                         human_num(stats.flist_size));
 434                 if (stats.flist_buildtime) {
 435                         rprintf(FINFO,
 436                                 "File list generation time: %s seconds\n",
 437                                 comma_dnum((double)stats.flist_buildtime / 1000, 3));
 438                         rprintf(FINFO,
 439                                 "File list transfer time: %s seconds\n",
 440                                 comma_dnum((double)stats.flist_xfertime / 1000, 3));
 441                 }
 442                 rprintf(FINFO,"Total bytes sent: %s\n",
 443                         human_num(total_written));
 444                 rprintf(FINFO,"Total bytes received: %s\n",
 445                         human_num(total_read));
 446         }
 447
 448         if (INFO_GTE(STATS, 1)) {
 449                 rprintf(FCLIENT, "\n");
 450                 rprintf(FINFO,
 451                         "sent %s bytes  received %s bytes  %s bytes/sec\n",
 452                         human_num(total_written), human_num(total_read),
 453                         bytes_per_sec_human_dnum());
 454                 rprintf(FINFO, "total size is %s  speedup is %s%s\n",
 455                         human_num(stats.total_size),
 456                         comma_dnum((double)stats.total_size / (total_written+total_read), 2),
 457                         write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
 458         }
 459
 460         fflush(stdout);
 461         fflush(stderr);
 462 }
 463
 464
 465 /**
 466  * If our C library can get malloc statistics, then show them to FINFO
 467  **/
 468 static void show_malloc_stats(void)
 469 {
 470 #ifdef HAVE_MALLINFO
 471         struct mallinfo mi;
 472
 473         mi = mallinfo();
 474
 475         rprintf(FCLIENT, "\n");
 476         rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
 477                 (int)getpid(), am_server ? "server " : "",
 478                 am_daemon ? "daemon " : "", who_am_i());
 479         rprintf(FINFO, "  arena:     %10ld   (bytes from sbrk)\n",
 480                 (long)mi.arena);
 481         rprintf(FINFO, "  ordblks:   %10ld   (chunks not in use)\n",
 482                 (long)mi.ordblks);
 483         rprintf(FINFO, "  smblks:    %10ld\n",
 484                 (long)mi.smblks);
 485         rprintf(FINFO, "  hblks:     %10ld   (chunks from mmap)\n",
 486                 (long)mi.hblks);
 487         rprintf(FINFO, "  hblkhd:    %10ld   (bytes from mmap)\n",
 488                 (long)mi.hblkhd);
 489         rprintf(FINFO, "  allmem:    %10ld   (bytes from sbrk + mmap)\n",
 490                 (long)mi.arena + mi.hblkhd);
 491         rprintf(FINFO, "  usmblks:   %10ld\n",
 492                 (long)mi.usmblks);
 493         rprintf(FINFO, "  fsmblks:   %10ld\n",
 494                 (long)mi.fsmblks);
 495         rprintf(FINFO, "  uordblks:  %10ld   (bytes used)\n",
 496                 (long)mi.uordblks);
 497         rprintf(FINFO, "  fordblks:  %10ld   (bytes free)\n",
 498                 (long)mi.fordblks);
 499         rprintf(FINFO, "  keepcost:  %10ld   (bytes in releasable chunk)\n",
 500                 (long)mi.keepcost);
 501 #endif /* HAVE_MALLINFO */
 502 }
 503
 504
 505 /* Start the remote shell.   cmd may be NULL to use the default. */
 506 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
 507                     int *f_in_p, int *f_out_p)
 508 {
 509         int i, argc = 0;
 510         char *args[MAX_ARGS], *need_to_free = NULL;
 511         pid_t pid;
 512         int dash_l_set = 0;
 513
 514         if (!read_batch && !local_server) {
 515                 char *t, *f, in_quote = '\0';
 516                 char *rsh_env = getenv(RSYNC_RSH_ENV);
 517                 if (!cmd)
 518                         cmd = rsh_env;
 519                 if (!cmd)
 520                         cmd = RSYNC_RSH;
 521                 cmd = need_to_free = strdup(cmd);
 522
 523                 for (t = f = cmd; *f; f++) {
 524                         if (*f == ' ')
 525                                 continue;
 526                         /* Comparison leaves rooms for server_options(). */
 527                         if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
 528                                 goto arg_overflow;
 529                         args[argc++] = t;
 530                         while (*f != ' ' || in_quote) {
 531                                 if (!*f) {
 532                                         if (in_quote) {
 533                                                 rprintf(FERROR,
 534                                                         "Missing trailing-%c in remote-shell command.\n",
 535                                                         in_quote);
 536                                                 exit_cleanup(RERR_SYNTAX);
 537                                         }
 538                                         f--;
 539                                         break;
 540                                 }
 541                                 if (*f == '\'' || *f == '"') {
 542                                         if (!in_quote) {
 543                                                 in_quote = *f++;
 544                                                 continue;
 545                                         }
 546                                         if (*f == in_quote && *++f != in_quote) {
 547                                                 in_quote = '\0';
 548                                                 continue;
 549                                         }
 550                                 }
 551                                 *t++ = *f++;
 552                         }
 553                         *t++ = '\0';
 554                 }
 555
 556                 /* NOTE: must preserve t == start of command name until the end of the args handling! */
 557                 if ((t = strrchr(cmd, '/')) != NULL)
 558                         t++;
 559                 else
 560                         t = cmd;
 561
 562                 /* Check to see if we've already been given '-l user' in the remote-shell command. */
 563                 for (i = 0; i < argc-1; i++) {
 564                         if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
 565                                 dash_l_set = 1;
 566                 }
 567
 568 #ifdef HAVE_REMSH
 569                 /* remsh (on HPUX) takes the arguments the other way around */
 570                 args[argc++] = machine;
 571                 if (user && !(daemon_connection && dash_l_set)) {
 572                         args[argc++] = "-l";
 573                         args[argc++] = user;
 574                 }
 575 #else
 576                 if (user && !(daemon_connection && dash_l_set)) {
 577                         args[argc++] = "-l";
 578                         args[argc++] = user;
 579                 }
 580 #ifdef AF_INET
 581                 if (default_af_hint == AF_INET && strcmp(t, "ssh") == 0)
 582                         args[argc++] = "-4"; /* we're using ssh so we can add a -4 option */
 583 #endif
 584 #ifdef AF_INET6
 585                 if (default_af_hint == AF_INET6 && strcmp(t, "ssh") == 0)
 586                         args[argc++] = "-6"; /* we're using ssh so we can add a -6 option */
 587 #endif
 588                 args[argc++] = machine;
 589 #endif
 590
 591                 args[argc++] = rsync_path;
 592
 593                 if (blocking_io < 0 && (strcmp(t, "rsh") == 0 || strcmp(t, "remsh") == 0))
 594                         blocking_io = 1;
 595
 596                 if (daemon_connection > 0) {
 597                         args[argc++] = "--server";
 598                         args[argc++] = "--daemon";
 599                 } else
 600                         server_options(args, &argc);
 601
 602                 if (argc >= MAX_ARGS - 2)
 603                         goto arg_overflow;
 604         }
 605
 606         args[argc++] = ".";
 607
 608         if (!daemon_connection) {
 609                 while (remote_argc > 0) {
 610                         if (argc >= MAX_ARGS - 1) {
 611                           arg_overflow:
 612                                 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
 613                                 exit_cleanup(RERR_SYNTAX);
 614                         }
 615                         if (**remote_argv == '-') {
 616                                 if (asprintf(args + argc++, "./%s", *remote_argv++) < 0)
 617                                         out_of_memory("do_cmd");
 618                         } else
 619                                 args[argc++] = *remote_argv++;
 620                         remote_argc--;
 621                 }
 622         }
 623
 624         args[argc] = NULL;
 625
 626         if (DEBUG_GTE(CMD, 2)) {
 627                 for (i = 0; i < argc; i++)
 628                         rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
 629                 rprintf(FCLIENT, "\n");
 630         }
 631
 632         if (read_batch) {
 633                 int from_gen_pipe[2];
 634                 set_allow_inc_recurse();
 635                 if (fd_pair(from_gen_pipe) < 0) {
 636                         rsyserr(FERROR, errno, "pipe");
 637                         exit_cleanup(RERR_IPC);
 638                 }
 639                 batch_gen_fd = from_gen_pipe[0];
 640                 *f_out_p = from_gen_pipe[1];
 641                 *f_in_p = batch_fd;
 642                 pid = (pid_t)-1; /* no child pid */
 643 #ifdef ICONV_CONST
 644                 setup_iconv();
 645 #endif
 646         } else if (local_server) {
 647                 /* If the user didn't request --[no-]whole-file, force
 648                  * it on, but only if we're not batch processing. */
 649                 if (whole_file < 0 && !write_batch)
 650                         whole_file = 1;
 651                 set_allow_inc_recurse();
 652                 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
 653 #ifdef ICONV_CONST
 654                 setup_iconv();
 655 #endif
 656         } else {
 657                 pid = piped_child(args, f_in_p, f_out_p);
 658 #ifdef ICONV_CONST
 659                 setup_iconv();
 660 #endif
 661                 if (protect_args && !daemon_connection)
 662                         send_protected_args(*f_out_p, args);
 663         }
 664
 665         if (need_to_free)
 666                 free(need_to_free);
 667
 668         return pid;
 669 }
 670
 671 /* The receiving side operates in one of two modes:
 672  *
 673  * 1. it receives any number of files into a destination directory,
 674  * placing them according to their names in the file-list.
 675  *
 676  * 2. it receives a single file and saves it using the name in the
 677  * destination path instead of its file-list name.  This requires a
 678  * "local name" for writing out the destination file.
 679  *
 680  * So, our task is to figure out what mode/local-name we need.
 681  * For mode 1, we change into the destination directory and return NULL.
 682  * For mode 2, we change into the directory containing the destination
 683  * file (if we aren't already there) and return the local-name. */
 684 static char *get_local_name(struct file_list *flist, char *dest_path)
 685 {
 686         STRUCT_STAT st;
 687         int statret, trailing_slash;
 688         char *cp;
 689
 690         if (DEBUG_GTE(RECV, 1)) {
 691                 rprintf(FINFO, "get_local_name count=%d %s\n",
 692                         file_total, NS(dest_path));
 693         }
 694
 695         if (!dest_path || list_only)
 696                 return NULL;
 697
 698         /* Treat an empty string as a copy into the current directory. */
 699         if (!*dest_path)
 700                 dest_path = ".";
 701
 702         if (daemon_filter_list.head) {
 703                 char *slash = strrchr(dest_path, '/');
 704                 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
 705                         *slash = '\0';
 706                 else
 707                         slash = NULL;
 708                 if ((*dest_path != '.' || dest_path[1] != '\0')
 709                  && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
 710                   || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
 711                         rprintf(FERROR, "ERROR: daemon has excluded destination \"%s\"\n",
 712                                 dest_path);
 713                         exit_cleanup(RERR_FILESELECT);
 714                 }
 715                 if (slash)
 716                         *slash = '/';
 717         }
 718
 719         /* See what currently exists at the destination. */
 720         statret = do_stat(dest_path, &st);
 721         cp = strrchr(dest_path, '/');
 722         trailing_slash = cp && !cp[1];
 723
 724         if (mkpath_dest_arg && statret < 0 && (cp || file_total > 1)) {
 725                 int save_errno = errno;
 726                 int ret = make_path(dest_path, file_total > 1 && !trailing_slash ? 0 : MKP_DROP_NAME);
 727                 if (ret < 0)
 728                         goto mkdir_error;
 729                 if (ret && (INFO_GTE(NAME, 1) || stdout_format_has_i)) {
 730                         if (file_total == 1 || trailing_slash)
 731                                 *cp = '\0';
 732                         rprintf(FINFO, "created %d director%s for %s\n", ret, ret == 1 ? "y" : "ies", dest_path);
 733                         if (file_total == 1 || trailing_slash)
 734                                 *cp = '/';
 735                 }
 736                 if (ret)
 737                         statret = do_stat(dest_path, &st);
 738                 else
 739                         errno = save_errno;
 740         }
 741
 742         if (statret == 0) {
 743                 /* If the destination is a dir, enter it and use mode 1. */
 744                 if (S_ISDIR(st.st_mode)) {
 745                         if (!change_dir(dest_path, CD_NORMAL)) {
 746                                 rsyserr(FERROR, errno, "change_dir#1 %s failed",
 747                                         full_fname(dest_path));
 748                                 exit_cleanup(RERR_FILESELECT);
 749                         }
 750                         filesystem_dev = st.st_dev; /* ensures --force works right w/-x */
 751                         return NULL;
 752                 }
 753                 if (file_total > 1) {
 754                         rprintf(FERROR,
 755                                 "ERROR: destination must be a directory when"
 756                                 " copying more than 1 file\n");
 757                         exit_cleanup(RERR_FILESELECT);
 758                 }
 759                 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
 760                         rprintf(FERROR,
 761                                 "ERROR: cannot overwrite non-directory"
 762                                 " with a directory\n");
 763                         exit_cleanup(RERR_FILESELECT);
 764                 }
 765         } else if (errno != ENOENT) {
 766                 /* If we don't know what's at the destination, fail. */
 767                 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
 768                         full_fname(dest_path));
 769                 exit_cleanup(RERR_FILESELECT);
 770         }
 771
 772         /* If we need a destination directory because the transfer is not
 773          * of a single non-directory or the user has requested one via a
 774          * destination path ending in a slash, create one and use mode 1. */
 775         if (file_total > 1 || trailing_slash) {
 776                 if (trailing_slash)
 777                         *cp = '\0'; /* Lop off the final slash (if any). */
 778
 779                 if (statret == 0) {
 780                         rprintf(FERROR, "ERROR: destination path is not a directory\n");
 781                         exit_cleanup(RERR_SYNTAX);
 782                 }
 783
 784                 if (do_mkdir(dest_path, ACCESSPERMS) != 0) {
 785                     mkdir_error:
 786                         rsyserr(FERROR, errno, "mkdir %s failed",
 787                                 full_fname(dest_path));
 788                         exit_cleanup(RERR_FILEIO);
 789                 }
 790
 791                 if (flist->high >= flist->low
 792                  && strcmp(flist->files[flist->low]->basename, ".") == 0)
 793                         flist->files[0]->flags |= FLAG_DIR_CREATED;
 794
 795                 if (INFO_GTE(NAME, 1) || stdout_format_has_i)
 796                         rprintf(FINFO, "created directory %s\n", dest_path);
 797
 798                 if (dry_run) {
 799                         /* Indicate that dest dir doesn't really exist. */
 800                         dry_run++;
 801                 }
 802
 803                 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
 804                         rsyserr(FERROR, errno, "change_dir#2 %s failed",
 805                                 full_fname(dest_path));
 806                         exit_cleanup(RERR_FILESELECT);
 807                 }
 808
 809                 return NULL;
 810         }
 811
 812         /* Otherwise, we are writing a single file, possibly on top of an
 813          * existing non-directory.  Change to the item's parent directory
 814          * (if it has a path component), return the basename of the
 815          * destination file as the local name, and use mode 2. */
 816         if (!cp)
 817                 return dest_path;
 818
 819         if (cp == dest_path)
 820                 dest_path = "/";
 821
 822         *cp = '\0';
 823         if (!change_dir(dest_path, CD_NORMAL)) {
 824                 rsyserr(FERROR, errno, "change_dir#3 %s failed",
 825                         full_fname(dest_path));
 826                 exit_cleanup(RERR_FILESELECT);
 827         }
 828         *cp = '/';
 829
 830         return cp + 1;
 831 }
 832
 833 /* This function checks on our alternate-basis directories.  If we're in
 834  * dry-run mode and the destination dir does not yet exist, we'll try to
 835  * tweak any dest-relative paths to make them work for a dry-run (the
 836  * destination dir must be in curr_dir[] when this function is called).
 837  * We also warn about any arg that is non-existent or not a directory. */
 838 static void check_alt_basis_dirs(void)
 839 {
 840         STRUCT_STAT st;
 841         char *slash = strrchr(curr_dir, '/');
 842         int j;
 843
 844         for (j = 0; j < basis_dir_cnt; j++) {
 845                 char *bdir = basis_dir[j];
 846                 int bd_len = strlen(bdir);
 847                 if (bd_len > 1 && bdir[bd_len-1] == '/')
 848                         bdir[--bd_len] = '\0';
 849                 if (dry_run > 1 && *bdir != '/') {
 850                         int len = curr_dir_len + 1 + bd_len + 1;
 851                         char *new = new_array(char, len);
 852                         if (slash && strncmp(bdir, "../", 3) == 0) {
 853                                 /* We want to remove only one leading "../" prefix for
 854                                  * the directory we couldn't create in dry-run mode:
 855                                  * this ensures that any other ".." references get
 856                                  * evaluated the same as they would for a live copy. */
 857                                 *slash = '\0';
 858                                 pathjoin(new, len, curr_dir, bdir + 3);
 859                                 *slash = '/';
 860                         } else
 861                                 pathjoin(new, len, curr_dir, bdir);
 862                         basis_dir[j] = bdir = new;
 863                 }
 864                 if (do_stat(bdir, &st) < 0)
 865                         rprintf(FWARNING, "%s arg does not exist: %s\n", alt_dest_opt(0), bdir);
 866                 else if (!S_ISDIR(st.st_mode))
 867                         rprintf(FWARNING, "%s arg is not a dir: %s\n", alt_dest_opt(0), bdir);
 868         }
 869 }
 870
 871 /* This is only called by the sender. */
 872 static void read_final_goodbye(int f_in, int f_out)
 873 {
 874         int i, iflags, xlen;
 875         uchar fnamecmp_type;
 876         char xname[MAXPATHLEN];
 877
 878         shutting_down = True;
 879
 880         if (protocol_version < 29)
 881                 i = read_int(f_in);
 882         else {
 883                 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
 884                 if (protocol_version >= 31 && i == NDX_DONE) {
 885                         if (am_sender)
 886                                 write_ndx(f_out, NDX_DONE);
 887                         else {
 888                                 if (batch_gen_fd >= 0) {
 889                                         while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
 890                                         read_del_stats(batch_gen_fd);
 891                                 }
 892                                 write_int(f_out, NDX_DONE);
 893                         }
 894                         i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
 895                 }
 896         }
 897
 898         if (i != NDX_DONE) {
 899                 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
 900                         i, who_am_i());
 901                 exit_cleanup(RERR_PROTOCOL);
 902         }
 903 }
 904
 905 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
 906 {
 907         struct file_list *flist;
 908         char *dir;
 909
 910         if (DEBUG_GTE(SEND, 1))
 911                 rprintf(FINFO, "server_sender starting pid=%d\n", (int)getpid());
 912
 913         if (am_daemon && lp_write_only(module_id)) {
 914                 rprintf(FERROR, "ERROR: module is write only\n");
 915                 exit_cleanup(RERR_SYNTAX);
 916         }
 917         if (am_daemon && read_only && remove_source_files) {
 918                 rprintf(FERROR,
 919                         "ERROR: --remove-%s-files cannot be used with a read-only module\n",
 920                         remove_source_files == 1 ? "source" : "sent");
 921                 exit_cleanup(RERR_SYNTAX);
 922         }
 923         if (argc < 1) {
 924                 rprintf(FERROR, "ERROR: do_server_sender called without args\n");
 925                 exit_cleanup(RERR_SYNTAX);
 926         }
 927
 928         become_copy_as_user();
 929
 930         dir = argv[0];
 931         if (!relative_paths) {
 932                 if (!change_dir(dir, CD_NORMAL)) {
 933                         rsyserr(FERROR, errno, "change_dir#3 %s failed",
 934                                 full_fname(dir));
 935                         exit_cleanup(RERR_FILESELECT);
 936                 }
 937         }
 938         argc--;
 939         argv++;
 940
 941         if (argc == 0 && (recurse || xfer_dirs || list_only)) {
 942                 argc = 1;
 943                 argv--;
 944                 argv[0] = ".";
 945         }
 946
 947         flist = send_file_list(f_out,argc,argv);
 948         if (!flist || flist->used == 0) {
 949                 /* Make sure input buffering is off so we can't hang in noop_io_until_death(). */
 950                 io_end_buffering_in(0);
 951                 /* TODO:  we should really exit in a more controlled manner. */
 952                 exit_cleanup(0);
 953         }
 954
 955         io_start_buffering_in(f_in);
 956
 957         send_files(f_in, f_out);
 958         io_flush(FULL_FLUSH);
 959         handle_stats(f_out);
 960         if (protocol_version >= 24)
 961                 read_final_goodbye(f_in, f_out);
 962         io_flush(FULL_FLUSH);
 963         exit_cleanup(0);
 964 }
 965
 966
 967 static int do_recv(int f_in, int f_out, char *local_name)
 968 {
 969         int pid;
 970         int exit_code = 0;
 971         int error_pipe[2];
 972
 973         /* The receiving side mustn't obey this, or an existing symlink that
 974          * points to an identical file won't be replaced by the referent. */
 975         copy_links = copy_dirlinks = copy_unsafe_links = 0;
 976
 977 #ifdef SUPPORT_HARD_LINKS
 978         if (preserve_hard_links && !inc_recurse)
 979                 match_hard_links(first_flist);
 980 #endif
 981
 982         if (fd_pair(error_pipe) < 0) {
 983                 rsyserr(FERROR, errno, "pipe failed in do_recv");
 984                 exit_cleanup(RERR_IPC);
 985         }
 986
 987         if (backup_dir) {
 988                 STRUCT_STAT st;
 989                 int ret;
 990                 if (backup_dir_len > 1)
 991                         backup_dir_buf[backup_dir_len-1] = '\0';
 992                 ret = do_stat(backup_dir_buf, &st);
 993                 if (ret != 0 || !S_ISDIR(st.st_mode)) {
 994                         if (ret == 0) {
 995                                 rprintf(FERROR, "The backup-dir is not a directory: %s\n", backup_dir_buf);
 996                                 exit_cleanup(RERR_SYNTAX);
 997                         }
 998                         if (errno != ENOENT) {
 999                                 rprintf(FERROR, "Failed to stat %s: %s\n", backup_dir_buf, strerror(errno));
1000                                 exit_cleanup(RERR_FILEIO);
1001                         }
1002                         if (INFO_GTE(BACKUP, 1))
1003                                 rprintf(FINFO, "(new) backup_dir is %s\n", backup_dir_buf);
1004                 } else if (INFO_GTE(BACKUP, 1))
1005                         rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
1006                 if (backup_dir_len > 1)
1007                         backup_dir_buf[backup_dir_len-1] = '/';
1008         }
1009
1010         if (tmpdir) {
1011                 STRUCT_STAT st;
1012                 int ret = do_stat(tmpdir, &st);
1013                 if (ret < 0 || !S_ISDIR(st.st_mode)) {
1014                         if (ret == 0) {
1015                                 rprintf(FERROR, "The temp-dir is not a directory: %s\n", tmpdir);
1016                                 exit_cleanup(RERR_SYNTAX);
1017                         }
1018                         if (errno == ENOENT) {
1019                                 rprintf(FERROR, "The temp-dir does not exist: %s\n", tmpdir);
1020                                 exit_cleanup(RERR_SYNTAX);
1021                         }
1022                         rprintf(FERROR, "Failed to stat temp-dir %s: %s\n", tmpdir, strerror(errno));
1023                         exit_cleanup(RERR_FILEIO);
1024                 }
1025         }
1026
1027         io_flush(FULL_FLUSH);
1028
1029         if ((pid = do_fork()) == -1) {
1030                 rsyserr(FERROR, errno, "fork failed in do_recv");
1031                 exit_cleanup(RERR_IPC);
1032         }
1033
1034         if (pid == 0) {
1035                 am_receiver = 1;
1036                 send_msgs_to_gen = am_server;
1037
1038                 close(error_pipe[0]);
1039
1040                 /* We can't let two processes write to the socket at one time. */
1041                 io_end_multiplex_out(MPLX_SWITCHING);
1042                 if (f_in != f_out)
1043                         close(f_out);
1044                 sock_f_out = -1;
1045                 f_out = error_pipe[1];
1046
1047                 bwlimit_writemax = 0; /* receiver doesn't need to do this */
1048
1049                 if (read_batch)
1050                         io_start_buffering_in(f_in);
1051                 io_start_multiplex_out(f_out);
1052
1053                 recv_files(f_in, f_out, local_name);
1054                 io_flush(FULL_FLUSH);
1055                 handle_stats(f_in);
1056
1057                 if (output_needs_newline) {
1058                         fputc('\n', stdout);
1059                         output_needs_newline = 0;
1060                 }
1061
1062                 write_int(f_out, NDX_DONE);
1063                 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
1064                 io_flush(FULL_FLUSH);
1065
1066                 /* Handle any keep-alive packets from the post-processing work
1067                  * that the generator does. */
1068                 if (protocol_version >= 29) {
1069                         kluge_around_eof = -1;
1070
1071                         /* This should only get stopped via a USR2 signal. */
1072                         read_final_goodbye(f_in, f_out);
1073
1074                         rprintf(FERROR, "Invalid packet at end of run [%s]\n",
1075                                 who_am_i());
1076                         exit_cleanup(RERR_PROTOCOL);
1077                 }
1078
1079                 /* Finally, we go to sleep until our parent kills us with a
1080                  * USR2 signal.  We sleep for a short time, as on some OSes
1081                  * a signal won't interrupt a sleep! */
1082                 while (1)
1083                         msleep(20);
1084         }
1085
1086         am_generator = 1;
1087         flist_receiving_enabled = True;
1088
1089         io_end_multiplex_in(MPLX_SWITCHING);
1090         if (write_batch && !am_server)
1091                 stop_write_batch();
1092
1093         close(error_pipe[1]);
1094         if (f_in != f_out)
1095                 close(f_in);
1096         sock_f_in = -1;
1097         f_in = error_pipe[0];
1098
1099         io_start_buffering_out(f_out);
1100         io_start_multiplex_in(f_in);
1101
1102 #ifdef SUPPORT_HARD_LINKS
1103         if (preserve_hard_links && inc_recurse) {
1104                 struct file_list *flist;
1105                 for (flist = first_flist; flist; flist = flist->next)
1106                         match_hard_links(flist);
1107         }
1108 #endif
1109
1110         generate_files(f_out, local_name);
1111
1112         handle_stats(-1);
1113         io_flush(FULL_FLUSH);
1114         shutting_down = True;
1115         if (protocol_version >= 24) {
1116                 /* send a final goodbye message */
1117                 write_ndx(f_out, NDX_DONE);
1118         }
1119         io_flush(FULL_FLUSH);
1120
1121         kill(pid, SIGUSR2);
1122         wait_process_with_flush(pid, &exit_code);
1123         return exit_code;
1124 }
1125
1126 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
1127 {
1128         int exit_code;
1129         struct file_list *flist;
1130         char *local_name = NULL;
1131         int negated_levels;
1132
1133         if (filesfrom_fd >= 0 && msgs2stderr != 1 && protocol_version < 31) {
1134                 /* We can't mix messages with files-from data on the socket,
1135                  * so temporarily turn off info/debug messages. */
1136                 negate_output_levels();
1137                 negated_levels = 1;
1138         } else
1139                 negated_levels = 0;
1140
1141         if (DEBUG_GTE(RECV, 1))
1142                 rprintf(FINFO, "server_recv(%d) starting pid=%d\n", argc, (int)getpid());
1143
1144         if (am_daemon && read_only) {
1145                 rprintf(FERROR,"ERROR: module is read only\n");
1146                 exit_cleanup(RERR_SYNTAX);
1147                 return;
1148         }
1149
1150         become_copy_as_user();
1151
1152         if (argc > 0) {
1153                 char *dir = argv[0];
1154                 argc--;
1155                 argv++;
1156                 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
1157                         rsyserr(FERROR, errno, "change_dir#4 %s failed",
1158                                 full_fname(dir));
1159                         exit_cleanup(RERR_FILESELECT);
1160                 }
1161         }
1162
1163         if (protocol_version >= 30)
1164                 io_start_multiplex_in(f_in);
1165         else
1166                 io_start_buffering_in(f_in);
1167         recv_filter_list(f_in);
1168
1169         if (filesfrom_fd >= 0) {
1170                 /* We need to send the files-from names to the sender at the
1171                  * same time that we receive the file-list from them, so we
1172                  * need the IO routines to automatically write out the names
1173                  * onto our f_out socket as we read the file-list.  This
1174                  * avoids both deadlock and extra delays/buffers. */
1175                 start_filesfrom_forwarding(filesfrom_fd);
1176                 filesfrom_fd = -1;
1177         }
1178
1179         flist = recv_file_list(f_in, -1);
1180         if (!flist) {
1181                 rprintf(FERROR,"server_recv: recv_file_list error\n");
1182                 exit_cleanup(RERR_FILESELECT);
1183         }
1184         if (inc_recurse && file_total == 1)
1185                 recv_additional_file_list(f_in);
1186
1187         if (negated_levels)
1188                 negate_output_levels();
1189
1190         if (argc > 0)
1191                 local_name = get_local_name(flist,argv[0]);
1192
1193         /* Now that we know what our destination directory turned out to be,
1194          * we can sanitize the --link-/copy-/compare-dest args correctly. */
1195         if (sanitize_paths) {
1196                 char **dir_p;
1197                 for (dir_p = basis_dir; *dir_p; dir_p++)
1198                         *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1199                 if (partial_dir)
1200                         partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1201         }
1202         check_alt_basis_dirs();
1203
1204         if (daemon_filter_list.head) {
1205                 char **dir_p;
1206                 filter_rule_list *elp = &daemon_filter_list;
1207
1208                 for (dir_p = basis_dir; *dir_p; dir_p++) {
1209                         char *dir = *dir_p;
1210                         if (*dir == '/')
1211                                 dir += module_dirlen;
1212                         if (check_filter(elp, FLOG, dir, 1) < 0)
1213                                 goto options_rejected;
1214                 }
1215                 if (partial_dir && *partial_dir == '/'
1216                  && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1217                     options_rejected:
1218                         rprintf(FERROR, "Your options have been rejected by the server.\n");
1219                         exit_cleanup(RERR_SYNTAX);
1220                 }
1221         }
1222
1223         exit_code = do_recv(f_in, f_out, local_name);
1224         exit_cleanup(exit_code);
1225 }
1226
1227
1228 int child_main(int argc, char *argv[])
1229 {
1230         start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1231         return 0;
1232 }
1233
1234
1235 void start_server(int f_in, int f_out, int argc, char *argv[])
1236 {
1237         set_nonblocking(f_in);
1238         set_nonblocking(f_out);
1239
1240         io_set_sock_fds(f_in, f_out);
1241         setup_protocol(f_out, f_in);
1242
1243         if (protocol_version >= 23)
1244                 io_start_multiplex_out(f_out);
1245         if (am_daemon && io_timeout && protocol_version >= 31)
1246                 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1247
1248         if (am_sender) {
1249                 keep_dirlinks = 0; /* Must be disabled on the sender. */
1250                 if (need_messages_from_generator)
1251                         io_start_multiplex_in(f_in);
1252                 else
1253                         io_start_buffering_in(f_in);
1254                 recv_filter_list(f_in);
1255                 do_server_sender(f_in, f_out, argc, argv);
1256         } else
1257                 do_server_recv(f_in, f_out, argc, argv);
1258         exit_cleanup(0);
1259 }
1260
1261 /* This is called once the connection has been negotiated.  It is used
1262  * for rsyncd, remote-shell, and local connections. */
1263 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1264 {
1265         struct file_list *flist = NULL;
1266         int exit_code = 0, exit_code2 = 0;
1267         char *local_name = NULL;
1268
1269         cleanup_child_pid = pid;
1270         if (!read_batch) {
1271                 set_nonblocking(f_in);
1272                 set_nonblocking(f_out);
1273         }
1274
1275         io_set_sock_fds(f_in, f_out);
1276         setup_protocol(f_out,f_in);
1277
1278         /* We set our stderr file handle to blocking because ssh might have
1279          * set it to non-blocking.  This can be particularly troublesome if
1280          * stderr is a clone of stdout, because ssh would have set our stdout
1281          * to non-blocking at the same time (which can easily cause us to lose
1282          * output from our print statements).  This kluge shouldn't cause ssh
1283          * any problems for how we use it.  Note also that we delayed setting
1284          * this until after the above protocol setup so that we know for sure
1285          * that ssh is done twiddling its file descriptors.  */
1286         set_blocking(STDERR_FILENO);
1287
1288         if (am_sender) {
1289                 keep_dirlinks = 0; /* Must be disabled on the sender. */
1290
1291                 if (always_checksum
1292                  && (log_format_has(stdout_format, 'C')
1293                   || log_format_has(logfile_format, 'C')))
1294                         sender_keeps_checksum = 1;
1295
1296                 if (protocol_version >= 30)
1297                         io_start_multiplex_out(f_out);
1298                 else
1299                         io_start_buffering_out(f_out);
1300                 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1301                         io_start_multiplex_in(f_in);
1302                 else
1303                         io_start_buffering_in(f_in);
1304                 send_filter_list(f_out);
1305                 if (filesfrom_host)
1306                         filesfrom_fd = f_in;
1307
1308                 if (write_batch && !am_server)
1309                         start_write_batch(f_out);
1310
1311                 become_copy_as_user();
1312
1313                 flist = send_file_list(f_out, argc, argv);
1314                 if (DEBUG_GTE(FLIST, 3))
1315                         rprintf(FINFO,"file list sent\n");
1316
1317                 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1318                         io_start_multiplex_in(f_in);
1319
1320                 io_flush(NORMAL_FLUSH);
1321                 send_files(f_in, f_out);
1322                 io_flush(FULL_FLUSH);
1323                 handle_stats(-1);
1324                 if (protocol_version >= 24)
1325                         read_final_goodbye(f_in, f_out);
1326                 if (pid != -1) {
1327                         if (DEBUG_GTE(EXIT, 2))
1328                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1329                         io_flush(FULL_FLUSH);
1330                         wait_process_with_flush(pid, &exit_code);
1331                 }
1332                 output_summary();
1333                 io_flush(FULL_FLUSH);
1334                 exit_cleanup(exit_code);
1335         }
1336
1337         if (!read_batch) {
1338                 if (protocol_version >= 23)
1339                         io_start_multiplex_in(f_in);
1340                 if (need_messages_from_generator)
1341                         io_start_multiplex_out(f_out);
1342                 else
1343                         io_start_buffering_out(f_out);
1344         }
1345
1346         become_copy_as_user();
1347
1348         send_filter_list(read_batch ? -1 : f_out);
1349
1350         if (filesfrom_fd >= 0) {
1351                 start_filesfrom_forwarding(filesfrom_fd);
1352                 filesfrom_fd = -1;
1353         }
1354
1355         if (write_batch && !am_server)
1356                 start_write_batch(f_in);
1357         flist = recv_file_list(f_in, -1);
1358         if (inc_recurse && file_total == 1)
1359                 recv_additional_file_list(f_in);
1360
1361         if (flist && flist->used > 0) {
1362                 local_name = get_local_name(flist, argv[0]);
1363
1364                 check_alt_basis_dirs();
1365
1366                 exit_code2 = do_recv(f_in, f_out, local_name);
1367         } else {
1368                 handle_stats(-1);
1369                 output_summary();
1370         }
1371
1372         if (pid != -1) {
1373                 if (DEBUG_GTE(RECV, 1))
1374                         rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1375                 io_flush(FULL_FLUSH);
1376                 wait_process_with_flush(pid, &exit_code);
1377         }
1378
1379         return MAX(exit_code, exit_code2);
1380 }
1381
1382 static void dup_argv(char *argv[])
1383 {
1384         int i;
1385
1386         for (i = 0; argv[i]; i++)
1387                 argv[i] = strdup(argv[i]);
1388 }
1389
1390
1391 /* Start a client for either type of remote connection.  Work out
1392  * whether the arguments request a remote shell or rsyncd connection,
1393  * and call the appropriate connection function, then run_client.
1394  *
1395  * Calls either start_socket_client (for sockets) or do_cmd and
1396  * client_run (for ssh). */
1397 static int start_client(int argc, char *argv[])
1398 {
1399         char *p, *shell_machine = NULL, *shell_user = NULL;
1400         char **remote_argv;
1401         int remote_argc, env_port = rsync_port;
1402         int f_in, f_out;
1403         int ret;
1404         pid_t pid;
1405
1406         /* Don't clobber argv[] so that ps(1) can still show the right
1407          * command line. */
1408         dup_argv(argv);
1409
1410         if (!read_batch) { /* for read_batch, NO source is specified */
1411                 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1412                 if (path) { /* source is remote */
1413                         char *dummy_host;
1414                         int dummy_port = 0;
1415                         *argv = path;
1416                         remote_argv = argv;
1417                         remote_argc = argc;
1418                         argv += argc - 1;
1419                         if (argc == 1 || **argv == ':')
1420                                 argc = 0; /* no dest arg */
1421                         else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1422                                 rprintf(FERROR,
1423                                         "The source and destination cannot both be remote.\n");
1424                                 exit_cleanup(RERR_SYNTAX);
1425                         } else {
1426                                 remote_argc--; /* don't count dest */
1427                                 argc = 1;
1428                         }
1429                         if (filesfrom_host && *filesfrom_host && strcmp(filesfrom_host, shell_machine) != 0) {
1430                                 rprintf(FERROR,
1431                                         "--files-from hostname is not the same as the transfer hostname\n");
1432                                 exit_cleanup(RERR_SYNTAX);
1433                         }
1434                         am_sender = 0;
1435                         if (rsync_port)
1436                                 daemon_connection = shell_cmd ? 1 : -1;
1437                 } else { /* source is local, check dest arg */
1438                         am_sender = 1;
1439
1440                         if (argc > 1) {
1441                                 p = argv[--argc];
1442                                 remote_argv = argv + argc;
1443                         } else {
1444                                 static char *dotarg[1] = { "." };
1445                                 p = dotarg[0];
1446                                 remote_argv = dotarg;
1447                         }
1448                         remote_argc = 1;
1449
1450                         path = check_for_hostspec(p, &shell_machine, &rsync_port);
1451                         if (path && filesfrom_host && *filesfrom_host && strcmp(filesfrom_host, shell_machine) != 0) {
1452                                 rprintf(FERROR,
1453                                         "--files-from hostname is not the same as the transfer hostname\n");
1454                                 exit_cleanup(RERR_SYNTAX);
1455                         }
1456                         if (!path) { /* no hostspec found, so src & dest are local */
1457                                 local_server = 1;
1458                                 if (filesfrom_host) {
1459                                         rprintf(FERROR,
1460                                                 "--files-from cannot be remote when the transfer is local\n");
1461                                         exit_cleanup(RERR_SYNTAX);
1462                                 }
1463                                 shell_machine = NULL;
1464                                 rsync_port = 0;
1465                         } else { /* hostspec was found, so dest is remote */
1466                                 argv[argc] = path;
1467                                 if (rsync_port)
1468                                         daemon_connection = shell_cmd ? 1 : -1;
1469                         }
1470                 }
1471         } else {  /* read_batch */
1472                 local_server = 1;
1473                 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1474                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1475                         exit_cleanup(RERR_SYNTAX);
1476                 }
1477                 remote_argv = argv += argc - 1;
1478                 remote_argc = argc = 1;
1479                 rsync_port = 0;
1480         }
1481
1482         if (!rsync_port && remote_argc && !**remote_argv) /* Turn an empty arg into a dot dir. */
1483                 *remote_argv = ".";
1484
1485         if (am_sender) {
1486                 char *dummy_host;
1487                 int dummy_port = rsync_port;
1488                 int i;
1489                 if (!argv[0][0])
1490                         goto invalid_empty;
1491                 /* For local source, extra source args must not have hostspec. */
1492                 for (i = 1; i < argc; i++) {
1493                         if (!argv[i][0]) {
1494                             invalid_empty:
1495                                 rprintf(FERROR, "Empty source arg specified.\n");
1496                                 exit_cleanup(RERR_SYNTAX);
1497                         }
1498                         if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1499                                 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1500                                 exit_cleanup(RERR_SYNTAX);
1501                         }
1502                 }
1503         } else {
1504                 char *dummy_host;
1505                 int dummy_port = rsync_port;
1506                 int i;
1507                 /* For remote source, any extra source args must have either
1508                  * the same hostname or an empty hostname. */
1509                 for (i = 1; i < remote_argc; i++) {
1510                         char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1511                         if (!arg) {
1512                                 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1513                                 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1514                                 exit_cleanup(RERR_SYNTAX);
1515                         }
1516                         if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1517                                 rprintf(FERROR, "All source args must come from the same machine.\n");
1518                                 exit_cleanup(RERR_SYNTAX);
1519                         }
1520                         if (rsync_port != dummy_port) {
1521                                 if (!rsync_port || !dummy_port)
1522                                         rprintf(FERROR, "All source args must use the same hostspec format.\n");
1523                                 else
1524                                         rprintf(FERROR, "All source args must use the same port number.\n");
1525                                 exit_cleanup(RERR_SYNTAX);
1526                         }
1527                         if (!rsync_port && !*arg) /* Turn an empty arg into a dot dir. */
1528                                 arg = ".";
1529                         remote_argv[i] = arg;
1530                 }
1531         }
1532
1533         if (rsync_port < 0)
1534                 rsync_port = RSYNC_PORT;
1535         else
1536                 env_port = rsync_port;
1537
1538         if (daemon_connection < 0)
1539                 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1540
1541         if (password_file && !daemon_connection) {
1542                 rprintf(FERROR, "The --password-file option may only be "
1543                                 "used when accessing an rsync daemon.\n");
1544                 exit_cleanup(RERR_SYNTAX);
1545         }
1546
1547         if (connect_timeout) {
1548                 rprintf(FERROR, "The --contimeout option may only be "
1549                                 "used when connecting to an rsync daemon.\n");
1550                 exit_cleanup(RERR_SYNTAX);
1551         }
1552
1553         if (shell_machine) {
1554                 p = strrchr(shell_machine,'@');
1555                 if (p) {
1556                         *p = 0;
1557                         shell_user = shell_machine;
1558                         shell_machine = p+1;
1559                 }
1560         }
1561
1562         if (DEBUG_GTE(CMD, 2)) {
1563                 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1564                         NS(shell_cmd), NS(shell_machine), NS(shell_user),
1565                         NS(remote_argv[0]));
1566         }
1567
1568 #ifdef HAVE_PUTENV
1569         if (daemon_connection)
1570                 set_env_num("RSYNC_PORT", env_port);
1571 #else
1572         (void)env_port;
1573 #endif
1574
1575         pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc, &f_in, &f_out);
1576
1577         /* if we're running an rsync server on the remote host over a
1578          * remote shell command, we need to do the RSYNCD protocol first */
1579         if (daemon_connection) {
1580                 int tmpret;
1581                 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1582                 if (tmpret < 0)
1583                         return tmpret;
1584         }
1585
1586         ret = client_run(f_in, f_out, pid, argc, argv);
1587
1588         fflush(stdout);
1589         fflush(stderr);
1590
1591         return ret;
1592 }
1593
1594
1595 static void sigusr1_handler(UNUSED(int val))
1596 {
1597         called_from_signal_handler = 1;
1598         exit_cleanup(RERR_SIGNAL1);
1599 }
1600
1601 static void sigusr2_handler(UNUSED(int val))
1602 {
1603         if (!am_server)
1604                 output_summary();
1605         close_all();
1606         if (got_xfer_error)
1607                 _exit(RERR_PARTIAL);
1608         _exit(0);
1609 }
1610
1611 #if defined SIGINFO || defined SIGVTALRM
1612 static void siginfo_handler(UNUSED(int val))
1613 {
1614         if (!am_server && !INFO_GTE(PROGRESS, 1))
1615                 want_progress_now = True;
1616 }
1617 #endif
1618
1619 void remember_children(UNUSED(int val))
1620 {
1621 #ifdef WNOHANG
1622         int cnt, status;
1623         pid_t pid;
1624         /* An empty waitpid() loop was put here by Tridge and we could never
1625          * get him to explain why he put it in, so rather than taking it
1626          * out we're instead saving the child exit statuses for later use.
1627          * The waitpid() loop presumably eliminates all possibility of leaving
1628          * zombie children, maybe that's why he did it. */
1629         while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1630                 /* save the child's exit status */
1631                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1632                         if (pid_stat_table[cnt].pid == 0) {
1633                                 pid_stat_table[cnt].pid = pid;
1634                                 pid_stat_table[cnt].status = status;
1635                                 break;
1636                         }
1637                 }
1638         }
1639 #endif
1640 #ifndef HAVE_SIGACTION
1641         signal(SIGCHLD, remember_children);
1642 #endif
1643 }
1644
1645 /**
1646  * This routine catches signals and tries to send them to gdb.
1647  *
1648  * Because it's called from inside a signal handler it ought not to
1649  * use too many library routines.
1650  *
1651  * @todo Perhaps use "screen -X" instead/as well, to help people
1652  * debugging without easy access to X.  Perhaps use an environment
1653  * variable, or just call a script?
1654  *
1655  * @todo The /proc/ magic probably only works on Linux (and
1656  * Solaris?)  Can we be more portable?
1657  **/
1658 #ifdef MAINTAINER_MODE
1659 const char *get_panic_action(void)
1660 {
1661         const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1662
1663         if (cmd_fmt)
1664                 return cmd_fmt;
1665         return "xterm -display :0 -T Panic -n Panic -e gdb /proc/%d/exe %d";
1666 }
1667
1668 /**
1669  * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1670  *
1671  * This signal handler is only installed if we were configured with
1672  * --enable-maintainer-mode.  Perhaps it should always be on and we
1673  * should just look at the environment variable, but I'm a bit leery
1674  * of a signal sending us into a busy loop.
1675  **/
1676 static void rsync_panic_handler(UNUSED(int whatsig))
1677 {
1678         char cmd_buf[300];
1679         int ret, pid_int = getpid();
1680
1681         snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(), pid_int, pid_int);
1682
1683         /* Unless we failed to execute gdb, we allow the process to
1684          * continue.  I'm not sure if that's right. */
1685         ret = shell_exec(cmd_buf);
1686         if (ret)
1687                 _exit(ret);
1688 }
1689 #endif
1690
1691 static void unset_env_var(const char *var)
1692 {
1693 #ifdef HAVE_UNSETENV
1694         unsetenv(var);
1695 #else
1696 #ifdef HAVE_PUTENV
1697         char *mem;
1698         if (asprintf(&mem, "%s=", var) < 0)
1699                 out_of_memory("unset_env_var");
1700         putenv(mem);
1701 #else
1702         (void)var;
1703 #endif
1704 #endif
1705 }
1706
1707
1708 int main(int argc,char *argv[])
1709 {
1710         int ret;
1711
1712         raw_argc = argc;
1713         raw_argv = argv;
1714
1715 #ifdef HAVE_SIGACTION
1716 # ifdef HAVE_SIGPROCMASK
1717         sigset_t sigmask;
1718
1719         sigemptyset(&sigmask);
1720 # endif
1721         sigact.sa_flags = SA_NOCLDSTOP;
1722 #endif
1723         SIGACTMASK(SIGUSR1, sigusr1_handler);
1724         SIGACTMASK(SIGUSR2, sigusr2_handler);
1725         SIGACTMASK(SIGCHLD, remember_children);
1726 #ifdef MAINTAINER_MODE
1727         SIGACTMASK(SIGSEGV, rsync_panic_handler);
1728         SIGACTMASK(SIGFPE, rsync_panic_handler);
1729         SIGACTMASK(SIGABRT, rsync_panic_handler);
1730         SIGACTMASK(SIGBUS, rsync_panic_handler);
1731 #endif
1732 #ifdef SIGINFO
1733         SIGACTMASK(SIGINFO, siginfo_handler);
1734 #endif
1735 #ifdef SIGVTALRM
1736         SIGACTMASK(SIGVTALRM, siginfo_handler);
1737 #endif
1738
1739         starttime = time(NULL);
1740         our_uid = MY_UID();
1741         our_gid = MY_GID();
1742         am_root = our_uid == ROOT_UID;
1743
1744         unset_env_var("DISPLAY");
1745
1746         memset(&stats, 0, sizeof(stats));
1747
1748         /* Even a non-daemon runs needs the default config values to be set, e.g.
1749          * lp_dont_compress() is queried when no --skip-compress option is set. */
1750         reset_daemon_vars();
1751
1752         if (argc < 2) {
1753                 usage(FERROR);
1754                 exit_cleanup(RERR_SYNTAX);
1755         }
1756
1757         /* Get the umask for use in permission calculations.  We no longer set
1758          * it to zero; that is ugly and pointless now that all the callers that
1759          * relied on it have been reeducated to work with default ACLs. */
1760         umask(orig_umask = umask(0));
1761
1762 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1763         setlocale(LC_CTYPE, "");
1764         setlocale(LC_NUMERIC, "");
1765 #endif
1766
1767         if (!parse_arguments(&argc, (const char ***) &argv)) {
1768                 option_error();
1769                 exit_cleanup(RERR_SYNTAX);
1770         }
1771         if (write_batch
1772          && poptDupArgv(argc, (const char **)argv, &cooked_argc, (const char ***)&cooked_argv) != 0)
1773                 out_of_memory("main");
1774
1775         SIGACTMASK(SIGINT, sig_int);
1776         SIGACTMASK(SIGHUP, sig_int);
1777         SIGACTMASK(SIGTERM, sig_int);
1778 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1779         sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1780 #endif
1781
1782         /* Ignore SIGPIPE; we consistently check error codes and will
1783          * see the EPIPE. */
1784         SIGACTION(SIGPIPE, SIG_IGN);
1785 #ifdef SIGXFSZ
1786         SIGACTION(SIGXFSZ, SIG_IGN);
1787 #endif
1788
1789         /* Initialize change_dir() here because on some old systems getcwd
1790          * (implemented by forking "pwd" and reading its output) doesn't
1791          * work when there are other child processes.  Also, on all systems
1792          * that implement getcwd that way "pwd" can't be found after chroot. */
1793         change_dir(NULL, CD_NORMAL);
1794
1795         if ((write_batch || read_batch) && !am_server) {
1796                 open_batch_files(); /* sets batch_fd */
1797                 if (read_batch)
1798                         read_stream_flags(batch_fd);
1799                 else
1800                         write_stream_flags(batch_fd);
1801         }
1802         if (write_batch < 0)
1803                 dry_run = 1;
1804
1805         if (am_server) {
1806 #ifdef ICONV_CONST
1807                 setup_iconv();
1808 #endif
1809         } else if (am_daemon)
1810                 return daemon_main();
1811
1812         if (am_server && protect_args) {
1813                 char buf[MAXPATHLEN];
1814                 protect_args = 2;
1815                 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1816                 if (!parse_arguments(&argc, (const char ***) &argv)) {
1817                         option_error();
1818                         exit_cleanup(RERR_SYNTAX);
1819                 }
1820         }
1821
1822         if (argc < 1) {
1823                 usage(FERROR);
1824                 exit_cleanup(RERR_SYNTAX);
1825         }
1826
1827         if (am_server) {
1828                 set_nonblocking(STDIN_FILENO);
1829                 set_nonblocking(STDOUT_FILENO);
1830                 if (am_daemon)
1831                         return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1832                 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1833         }
1834
1835         ret = start_client(argc, argv);
1836         if (ret == -1)
1837                 exit_cleanup(RERR_STARTCLIENT);
1838         else
1839                 exit_cleanup(ret);
1840
1841         return ret;
1842 }