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-2022 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 MEM_ALLOC_INFO
 471         struct MEM_ALLOC_INFO mi = MEM_ALLOC_INFO(); /* mallinfo or mallinfo2 */
 472
 473         rprintf(FCLIENT, "\n");
 474         rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
 475                 (int)getpid(), am_server ? "server " : "",
 476                 am_daemon ? "daemon " : "", who_am_i());
 477
 478 #define PRINT_ALLOC_NUM(title, descr, num) \
 479         rprintf(FINFO, "  %-11s%10" SIZE_T_FMT_MOD "d   (" descr ")\n", \
 480                title ":", (SIZE_T_FMT_CAST)(num));
 481
 482         PRINT_ALLOC_NUM("arena", "bytes from sbrk", mi.arena);
 483         PRINT_ALLOC_NUM("ordblks", "chunks not in use", mi.ordblks);
 484         PRINT_ALLOC_NUM("smblks", "free fastbin blocks", mi.smblks);
 485         PRINT_ALLOC_NUM("hblks", "chunks from mmap", mi.hblks);
 486         PRINT_ALLOC_NUM("hblkhd", "bytes from mmap", mi.hblkhd);
 487         PRINT_ALLOC_NUM("allmem", "bytes from sbrk + mmap", mi.arena + mi.hblkhd);
 488         PRINT_ALLOC_NUM("usmblks", "always 0", mi.usmblks);
 489         PRINT_ALLOC_NUM("fsmblks", "bytes in freed fastbin blocks", mi.fsmblks);
 490         PRINT_ALLOC_NUM("uordblks", "bytes used", mi.uordblks);
 491         PRINT_ALLOC_NUM("fordblks", "bytes free", mi.fordblks);
 492         PRINT_ALLOC_NUM("keepcost", "bytes in releasable chunk", mi.keepcost);
 493
 494 #undef PRINT_ALLOC_NUM
 495
 496 #endif /* MEM_ALLOC_INFO */
 497 }
 498
 499
 500 /* Start the remote shell.   cmd may be NULL to use the default. */
 501 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
 502                     int *f_in_p, int *f_out_p)
 503 {
 504         int i, argc = 0;
 505         char *args[MAX_ARGS], *need_to_free = NULL;
 506         pid_t pid;
 507         int dash_l_set = 0;
 508
 509         if (!read_batch && !local_server) {
 510                 char *t, *f, in_quote = '\0';
 511                 char *rsh_env = getenv(RSYNC_RSH_ENV);
 512                 if (!cmd)
 513                         cmd = rsh_env;
 514                 if (!cmd)
 515                         cmd = RSYNC_RSH;
 516                 cmd = need_to_free = strdup(cmd);
 517
 518                 for (t = f = cmd; *f; f++) {
 519                         if (*f == ' ')
 520                                 continue;
 521                         /* Comparison leaves rooms for server_options(). */
 522                         if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
 523                                 goto arg_overflow;
 524                         args[argc++] = t;
 525                         while (*f != ' ' || in_quote) {
 526                                 if (!*f) {
 527                                         if (in_quote) {
 528                                                 rprintf(FERROR,
 529                                                         "Missing trailing-%c in remote-shell command.\n",
 530                                                         in_quote);
 531                                                 exit_cleanup(RERR_SYNTAX);
 532                                         }
 533                                         f--;
 534                                         break;
 535                                 }
 536                                 if (*f == '\'' || *f == '"') {
 537                                         if (!in_quote) {
 538                                                 in_quote = *f++;
 539                                                 continue;
 540                                         }
 541                                         if (*f == in_quote && *++f != in_quote) {
 542                                                 in_quote = '\0';
 543                                                 continue;
 544                                         }
 545                                 }
 546                                 *t++ = *f++;
 547                         }
 548                         *t++ = '\0';
 549                 }
 550
 551                 /* NOTE: must preserve t == start of command name until the end of the args handling! */
 552                 if ((t = strrchr(cmd, '/')) != NULL)
 553                         t++;
 554                 else
 555                         t = cmd;
 556
 557                 /* Check to see if we've already been given '-l user' in the remote-shell command. */
 558                 for (i = 0; i < argc-1; i++) {
 559                         if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
 560                                 dash_l_set = 1;
 561                 }
 562
 563 #ifdef HAVE_REMSH
 564                 /* remsh (on HPUX) takes the arguments the other way around */
 565                 args[argc++] = machine;
 566                 if (user && !(daemon_connection && dash_l_set)) {
 567                         args[argc++] = "-l";
 568                         args[argc++] = user;
 569                 }
 570 #else
 571                 if (user && !(daemon_connection && dash_l_set)) {
 572                         args[argc++] = "-l";
 573                         args[argc++] = user;
 574                 }
 575 #ifdef AF_INET
 576                 if (default_af_hint == AF_INET && strcmp(t, "ssh") == 0)
 577                         args[argc++] = "-4"; /* we're using ssh so we can add a -4 option */
 578 #endif
 579 #ifdef AF_INET6
 580                 if (default_af_hint == AF_INET6 && strcmp(t, "ssh") == 0)
 581                         args[argc++] = "-6"; /* we're using ssh so we can add a -6 option */
 582 #endif
 583                 args[argc++] = machine;
 584 #endif
 585
 586                 args[argc++] = rsync_path;
 587
 588                 if (blocking_io < 0 && (strcmp(t, "rsh") == 0 || strcmp(t, "remsh") == 0))
 589                         blocking_io = 1;
 590
 591                 if (daemon_connection > 0) {
 592                         args[argc++] = "--server";
 593                         args[argc++] = "--daemon";
 594                 } else
 595                         server_options(args, &argc);
 596
 597                 if (argc >= MAX_ARGS - 2)
 598                         goto arg_overflow;
 599         }
 600
 601         args[argc++] = ".";
 602
 603         if (!daemon_connection) {
 604                 while (remote_argc > 0) {
 605                         if (argc >= MAX_ARGS - 1) {
 606                           arg_overflow:
 607                                 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
 608                                 exit_cleanup(RERR_SYNTAX);
 609                         }
 610                         args[argc++] = safe_arg(NULL, *remote_argv++);
 611                         remote_argc--;
 612                 }
 613         }
 614
 615         args[argc] = NULL;
 616
 617         if (DEBUG_GTE(CMD, 2)) {
 618                 for (i = 0; i < argc; i++)
 619                         rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
 620                 rprintf(FCLIENT, "\n");
 621         }
 622
 623         if (read_batch) {
 624                 int from_gen_pipe[2];
 625                 set_allow_inc_recurse();
 626                 if (fd_pair(from_gen_pipe) < 0) {
 627                         rsyserr(FERROR, errno, "pipe");
 628                         exit_cleanup(RERR_IPC);
 629                 }
 630                 batch_gen_fd = from_gen_pipe[0];
 631                 *f_out_p = from_gen_pipe[1];
 632                 *f_in_p = batch_fd;
 633                 pid = (pid_t)-1; /* no child pid */
 634 #ifdef ICONV_CONST
 635                 setup_iconv();
 636 #endif
 637         } else if (local_server) {
 638                 /* If the user didn't request --[no-]whole-file, force
 639                  * it on, but only if we're not batch processing. */
 640                 if (whole_file < 0 && !write_batch)
 641                         whole_file = 1;
 642                 set_allow_inc_recurse();
 643                 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
 644 #ifdef ICONV_CONST
 645                 setup_iconv();
 646 #endif
 647         } else {
 648                 pid = piped_child(args, f_in_p, f_out_p);
 649 #ifdef ICONV_CONST
 650                 setup_iconv();
 651 #endif
 652                 if (protect_args && !daemon_connection)
 653                         send_protected_args(*f_out_p, args);
 654         }
 655
 656         if (need_to_free)
 657                 free(need_to_free);
 658
 659         return pid;
 660 }
 661
 662 /* The receiving side operates in one of two modes:
 663  *
 664  * 1. it receives any number of files into a destination directory,
 665  * placing them according to their names in the file-list.
 666  *
 667  * 2. it receives a single file and saves it using the name in the
 668  * destination path instead of its file-list name.  This requires a
 669  * "local name" for writing out the destination file.
 670  *
 671  * So, our task is to figure out what mode/local-name we need.
 672  * For mode 1, we change into the destination directory and return NULL.
 673  * For mode 2, we change into the directory containing the destination
 674  * file (if we aren't already there) and return the local-name. */
 675 static char *get_local_name(struct file_list *flist, char *dest_path)
 676 {
 677         STRUCT_STAT st;
 678         int statret, trailing_slash;
 679         char *cp;
 680
 681         if (DEBUG_GTE(RECV, 1)) {
 682                 rprintf(FINFO, "get_local_name count=%d %s\n",
 683                         file_total, NS(dest_path));
 684         }
 685
 686         if (!dest_path || list_only)
 687                 return NULL;
 688
 689         /* Treat an empty string as a copy into the current directory. */
 690         if (!*dest_path)
 691                 dest_path = ".";
 692
 693         if (daemon_filter_list.head) {
 694                 char *slash = strrchr(dest_path, '/');
 695                 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
 696                         *slash = '\0';
 697                 else
 698                         slash = NULL;
 699                 if ((*dest_path != '.' || dest_path[1] != '\0')
 700                  && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
 701                   || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
 702                         rprintf(FERROR, "ERROR: daemon has excluded destination \"%s\"\n",
 703                                 dest_path);
 704                         exit_cleanup(RERR_FILESELECT);
 705                 }
 706                 if (slash)
 707                         *slash = '/';
 708         }
 709
 710         /* See what currently exists at the destination. */
 711         statret = do_stat(dest_path, &st);
 712         cp = strrchr(dest_path, '/');
 713         trailing_slash = cp && !cp[1];
 714
 715         if (mkpath_dest_arg && statret < 0 && (cp || file_total > 1)) {
 716                 int save_errno = errno;
 717                 int ret = make_path(dest_path, file_total > 1 && !trailing_slash ? 0 : MKP_DROP_NAME);
 718                 if (ret < 0)
 719                         goto mkdir_error;
 720                 if (ret && (INFO_GTE(NAME, 1) || stdout_format_has_i)) {
 721                         if (file_total == 1 || trailing_slash)
 722                                 *cp = '\0';
 723                         rprintf(FINFO, "created %d director%s for %s\n", ret, ret == 1 ? "y" : "ies", dest_path);
 724                         if (file_total == 1 || trailing_slash)
 725                                 *cp = '/';
 726                 }
 727                 if (ret)
 728                         statret = do_stat(dest_path, &st);
 729                 else
 730                         errno = save_errno;
 731         }
 732
 733         if (statret == 0) {
 734                 /* If the destination is a dir, enter it and use mode 1. */
 735                 if (S_ISDIR(st.st_mode)) {
 736                         if (!change_dir(dest_path, CD_NORMAL)) {
 737                                 rsyserr(FERROR, errno, "change_dir#1 %s failed",
 738                                         full_fname(dest_path));
 739                                 exit_cleanup(RERR_FILESELECT);
 740                         }
 741                         filesystem_dev = st.st_dev; /* ensures --force works right w/-x */
 742                         return NULL;
 743                 }
 744                 if (file_total > 1) {
 745                         rprintf(FERROR,
 746                                 "ERROR: destination must be a directory when"
 747                                 " copying more than 1 file\n");
 748                         exit_cleanup(RERR_FILESELECT);
 749                 }
 750                 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
 751                         rprintf(FERROR,
 752                                 "ERROR: cannot overwrite non-directory"
 753                                 " with a directory\n");
 754                         exit_cleanup(RERR_FILESELECT);
 755                 }
 756         } else if (errno != ENOENT) {
 757                 /* If we don't know what's at the destination, fail. */
 758                 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
 759                         full_fname(dest_path));
 760                 exit_cleanup(RERR_FILESELECT);
 761         }
 762
 763         /* If we need a destination directory because the transfer is not
 764          * of a single non-directory or the user has requested one via a
 765          * destination path ending in a slash, create one and use mode 1. */
 766         if (file_total > 1 || trailing_slash) {
 767                 if (trailing_slash)
 768                         *cp = '\0'; /* Lop off the final slash (if any). */
 769
 770                 if (statret == 0) {
 771                         rprintf(FERROR, "ERROR: destination path is not a directory\n");
 772                         exit_cleanup(RERR_SYNTAX);
 773                 }
 774
 775                 if (do_mkdir(dest_path, ACCESSPERMS) != 0) {
 776                     mkdir_error:
 777                         rsyserr(FERROR, errno, "mkdir %s failed",
 778                                 full_fname(dest_path));
 779                         exit_cleanup(RERR_FILEIO);
 780                 }
 781
 782                 if (flist->high >= flist->low
 783                  && strcmp(flist->files[flist->low]->basename, ".") == 0)
 784                         flist->files[0]->flags |= FLAG_DIR_CREATED;
 785
 786                 if (INFO_GTE(NAME, 1) || stdout_format_has_i)
 787                         rprintf(FINFO, "created directory %s\n", dest_path);
 788
 789                 if (dry_run) {
 790                         /* Indicate that dest dir doesn't really exist. */
 791                         dry_run++;
 792                 }
 793
 794                 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
 795                         rsyserr(FERROR, errno, "change_dir#2 %s failed",
 796                                 full_fname(dest_path));
 797                         exit_cleanup(RERR_FILESELECT);
 798                 }
 799
 800                 return NULL;
 801         }
 802
 803         /* Otherwise, we are writing a single file, possibly on top of an
 804          * existing non-directory.  Change to the item's parent directory
 805          * (if it has a path component), return the basename of the
 806          * destination file as the local name, and use mode 2. */
 807         if (!cp)
 808                 return dest_path;
 809
 810         if (cp == dest_path)
 811                 dest_path = "/";
 812
 813         *cp = '\0';
 814         if (!change_dir(dest_path, CD_NORMAL)) {
 815                 rsyserr(FERROR, errno, "change_dir#3 %s failed",
 816                         full_fname(dest_path));
 817                 exit_cleanup(RERR_FILESELECT);
 818         }
 819         *cp = '/';
 820
 821         return cp + 1;
 822 }
 823
 824 /* This function checks on our alternate-basis directories.  If we're in
 825  * dry-run mode and the destination dir does not yet exist, we'll try to
 826  * tweak any dest-relative paths to make them work for a dry-run (the
 827  * destination dir must be in curr_dir[] when this function is called).
 828  * We also warn about any arg that is non-existent or not a directory. */
 829 static void check_alt_basis_dirs(void)
 830 {
 831         STRUCT_STAT st;
 832         char *slash = strrchr(curr_dir, '/');
 833         int j;
 834
 835         for (j = 0; j < basis_dir_cnt; j++) {
 836                 char *bdir = basis_dir[j];
 837                 int bd_len = strlen(bdir);
 838                 if (bd_len > 1 && bdir[bd_len-1] == '/')
 839                         bdir[--bd_len] = '\0';
 840                 if (dry_run > 1 && *bdir != '/') {
 841                         int len = curr_dir_len + 1 + bd_len + 1;
 842                         char *new = new_array(char, len);
 843                         if (slash && strncmp(bdir, "../", 3) == 0) {
 844                                 /* We want to remove only one leading "../" prefix for
 845                                  * the directory we couldn't create in dry-run mode:
 846                                  * this ensures that any other ".." references get
 847                                  * evaluated the same as they would for a live copy. */
 848                                 *slash = '\0';
 849                                 pathjoin(new, len, curr_dir, bdir + 3);
 850                                 *slash = '/';
 851                         } else
 852                                 pathjoin(new, len, curr_dir, bdir);
 853                         basis_dir[j] = bdir = new;
 854                 }
 855                 if (do_stat(bdir, &st) < 0)
 856                         rprintf(FWARNING, "%s arg does not exist: %s\n", alt_dest_opt(0), bdir);
 857                 else if (!S_ISDIR(st.st_mode))
 858                         rprintf(FWARNING, "%s arg is not a dir: %s\n", alt_dest_opt(0), bdir);
 859         }
 860 }
 861
 862 /* This is only called by the sender. */
 863 static void read_final_goodbye(int f_in, int f_out)
 864 {
 865         int i, iflags, xlen;
 866         uchar fnamecmp_type;
 867         char xname[MAXPATHLEN];
 868
 869         shutting_down = True;
 870
 871         if (protocol_version < 29)
 872                 i = read_int(f_in);
 873         else {
 874                 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
 875                 if (protocol_version >= 31 && i == NDX_DONE) {
 876                         if (am_sender)
 877                                 write_ndx(f_out, NDX_DONE);
 878                         else {
 879                                 if (batch_gen_fd >= 0) {
 880                                         while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
 881                                         read_del_stats(batch_gen_fd);
 882                                 }
 883                                 write_int(f_out, NDX_DONE);
 884                         }
 885                         i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
 886                 }
 887         }
 888
 889         if (i != NDX_DONE) {
 890                 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
 891                         i, who_am_i());
 892                 exit_cleanup(RERR_PROTOCOL);
 893         }
 894 }
 895
 896 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
 897 {
 898         struct file_list *flist;
 899         char *dir;
 900
 901         if (DEBUG_GTE(SEND, 1))
 902                 rprintf(FINFO, "server_sender starting pid=%d\n", (int)getpid());
 903
 904         if (am_daemon && lp_write_only(module_id)) {
 905                 rprintf(FERROR, "ERROR: module is write only\n");
 906                 exit_cleanup(RERR_SYNTAX);
 907         }
 908         if (am_daemon && read_only && remove_source_files) {
 909                 rprintf(FERROR,
 910                         "ERROR: --remove-%s-files cannot be used with a read-only module\n",
 911                         remove_source_files == 1 ? "source" : "sent");
 912                 exit_cleanup(RERR_SYNTAX);
 913         }
 914         if (argc < 1) {
 915                 rprintf(FERROR, "ERROR: do_server_sender called without args\n");
 916                 exit_cleanup(RERR_SYNTAX);
 917         }
 918
 919         become_copy_as_user();
 920
 921         dir = argv[0];
 922         if (!relative_paths) {
 923                 if (!change_dir(dir, CD_NORMAL)) {
 924                         rsyserr(FERROR, errno, "change_dir#3 %s failed",
 925                                 full_fname(dir));
 926                         exit_cleanup(RERR_FILESELECT);
 927                 }
 928         }
 929         argc--;
 930         argv++;
 931
 932         if (argc == 0 && (recurse || xfer_dirs || list_only)) {
 933                 argc = 1;
 934                 argv--;
 935                 argv[0] = ".";
 936         }
 937
 938         flist = send_file_list(f_out,argc,argv);
 939         if (!flist || flist->used == 0) {
 940                 /* Make sure input buffering is off so we can't hang in noop_io_until_death(). */
 941                 io_end_buffering_in(0);
 942                 /* TODO:  we should really exit in a more controlled manner. */
 943                 exit_cleanup(0);
 944         }
 945
 946         io_start_buffering_in(f_in);
 947
 948         send_files(f_in, f_out);
 949         io_flush(FULL_FLUSH);
 950         handle_stats(f_out);
 951         if (protocol_version >= 24)
 952                 read_final_goodbye(f_in, f_out);
 953         io_flush(FULL_FLUSH);
 954         exit_cleanup(0);
 955 }
 956
 957
 958 static int do_recv(int f_in, int f_out, char *local_name)
 959 {
 960         int pid;
 961         int exit_code = 0;
 962         int error_pipe[2];
 963
 964         /* The receiving side mustn't obey this, or an existing symlink that
 965          * points to an identical file won't be replaced by the referent. */
 966         copy_links = copy_dirlinks = copy_unsafe_links = 0;
 967
 968 #ifdef SUPPORT_HARD_LINKS
 969         if (preserve_hard_links && !inc_recurse)
 970                 match_hard_links(first_flist);
 971 #endif
 972
 973         if (fd_pair(error_pipe) < 0) {
 974                 rsyserr(FERROR, errno, "pipe failed in do_recv");
 975                 exit_cleanup(RERR_IPC);
 976         }
 977
 978         if (backup_dir) {
 979                 STRUCT_STAT st;
 980                 int ret;
 981                 if (backup_dir_len > 1)
 982                         backup_dir_buf[backup_dir_len-1] = '\0';
 983                 ret = do_stat(backup_dir_buf, &st);
 984                 if (ret != 0 || !S_ISDIR(st.st_mode)) {
 985                         if (ret == 0) {
 986                                 rprintf(FERROR, "The backup-dir is not a directory: %s\n", backup_dir_buf);
 987                                 exit_cleanup(RERR_SYNTAX);
 988                         }
 989                         if (errno != ENOENT) {
 990                                 rprintf(FERROR, "Failed to stat %s: %s\n", backup_dir_buf, strerror(errno));
 991                                 exit_cleanup(RERR_FILEIO);
 992                         }
 993                         if (INFO_GTE(BACKUP, 1))
 994                                 rprintf(FINFO, "(new) backup_dir is %s\n", backup_dir_buf);
 995                 } else if (INFO_GTE(BACKUP, 1))
 996                         rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
 997                 if (backup_dir_len > 1)
 998                         backup_dir_buf[backup_dir_len-1] = '/';
 999         }
1000
1001         if (tmpdir) {
1002                 STRUCT_STAT st;
1003                 int ret = do_stat(tmpdir, &st);
1004                 if (ret < 0 || !S_ISDIR(st.st_mode)) {
1005                         if (ret == 0) {
1006                                 rprintf(FERROR, "The temp-dir is not a directory: %s\n", tmpdir);
1007                                 exit_cleanup(RERR_SYNTAX);
1008                         }
1009                         if (errno == ENOENT) {
1010                                 rprintf(FERROR, "The temp-dir does not exist: %s\n", tmpdir);
1011                                 exit_cleanup(RERR_SYNTAX);
1012                         }
1013                         rprintf(FERROR, "Failed to stat temp-dir %s: %s\n", tmpdir, strerror(errno));
1014                         exit_cleanup(RERR_FILEIO);
1015                 }
1016         }
1017
1018         io_flush(FULL_FLUSH);
1019
1020         if ((pid = do_fork()) == -1) {
1021                 rsyserr(FERROR, errno, "fork failed in do_recv");
1022                 exit_cleanup(RERR_IPC);
1023         }
1024
1025         if (pid == 0) {
1026                 am_receiver = 1;
1027                 send_msgs_to_gen = am_server;
1028
1029                 close(error_pipe[0]);
1030
1031                 /* We can't let two processes write to the socket at one time. */
1032                 io_end_multiplex_out(MPLX_SWITCHING);
1033                 if (f_in != f_out)
1034                         close(f_out);
1035                 sock_f_out = -1;
1036                 f_out = error_pipe[1];
1037
1038                 bwlimit_writemax = 0; /* receiver doesn't need to do this */
1039
1040                 if (read_batch)
1041                         io_start_buffering_in(f_in);
1042                 io_start_multiplex_out(f_out);
1043
1044                 recv_files(f_in, f_out, local_name);
1045                 io_flush(FULL_FLUSH);
1046                 handle_stats(f_in);
1047
1048                 if (output_needs_newline) {
1049                         fputc('\n', stdout);
1050                         output_needs_newline = 0;
1051                 }
1052
1053                 write_int(f_out, NDX_DONE);
1054                 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
1055                 io_flush(FULL_FLUSH);
1056
1057                 /* Handle any keep-alive packets from the post-processing work
1058                  * that the generator does. */
1059                 if (protocol_version >= 29) {
1060                         kluge_around_eof = -1;
1061
1062                         /* This should only get stopped via a USR2 signal. */
1063                         read_final_goodbye(f_in, f_out);
1064
1065                         rprintf(FERROR, "Invalid packet at end of run [%s]\n",
1066                                 who_am_i());
1067                         exit_cleanup(RERR_PROTOCOL);
1068                 }
1069
1070                 /* Finally, we go to sleep until our parent kills us with a
1071                  * USR2 signal.  We sleep for a short time, as on some OSes
1072                  * a signal won't interrupt a sleep! */
1073                 while (1)
1074                         msleep(20);
1075         }
1076
1077         am_generator = 1;
1078         flist_receiving_enabled = True;
1079
1080         io_end_multiplex_in(MPLX_SWITCHING);
1081         if (write_batch && !am_server)
1082                 stop_write_batch();
1083
1084         close(error_pipe[1]);
1085         if (f_in != f_out)
1086                 close(f_in);
1087         sock_f_in = -1;
1088         f_in = error_pipe[0];
1089
1090         io_start_buffering_out(f_out);
1091         io_start_multiplex_in(f_in);
1092
1093 #ifdef SUPPORT_HARD_LINKS
1094         if (preserve_hard_links && inc_recurse) {
1095                 struct file_list *flist;
1096                 for (flist = first_flist; flist; flist = flist->next)
1097                         match_hard_links(flist);
1098         }
1099 #endif
1100
1101         generate_files(f_out, local_name);
1102
1103         handle_stats(-1);
1104         io_flush(FULL_FLUSH);
1105         shutting_down = True;
1106         if (protocol_version >= 24) {
1107                 /* send a final goodbye message */
1108                 write_ndx(f_out, NDX_DONE);
1109         }
1110         io_flush(FULL_FLUSH);
1111
1112         kill(pid, SIGUSR2);
1113         wait_process_with_flush(pid, &exit_code);
1114         return exit_code;
1115 }
1116
1117 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
1118 {
1119         int exit_code;
1120         struct file_list *flist;
1121         char *local_name = NULL;
1122         int negated_levels;
1123
1124         if (filesfrom_fd >= 0 && msgs2stderr != 1 && protocol_version < 31) {
1125                 /* We can't mix messages with files-from data on the socket,
1126                  * so temporarily turn off info/debug messages. */
1127                 negate_output_levels();
1128                 negated_levels = 1;
1129         } else
1130                 negated_levels = 0;
1131
1132         if (DEBUG_GTE(RECV, 1))
1133                 rprintf(FINFO, "server_recv(%d) starting pid=%d\n", argc, (int)getpid());
1134
1135         if (am_daemon && read_only) {
1136                 rprintf(FERROR,"ERROR: module is read only\n");
1137                 exit_cleanup(RERR_SYNTAX);
1138                 return;
1139         }
1140
1141         become_copy_as_user();
1142
1143         if (argc > 0) {
1144                 char *dir = argv[0];
1145                 argc--;
1146                 argv++;
1147                 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
1148                         rsyserr(FERROR, errno, "change_dir#4 %s failed",
1149                                 full_fname(dir));
1150                         exit_cleanup(RERR_FILESELECT);
1151                 }
1152         }
1153
1154         if (protocol_version >= 30)
1155                 io_start_multiplex_in(f_in);
1156         else
1157                 io_start_buffering_in(f_in);
1158         recv_filter_list(f_in);
1159
1160         if (filesfrom_fd >= 0) {
1161                 /* We need to send the files-from names to the sender at the
1162                  * same time that we receive the file-list from them, so we
1163                  * need the IO routines to automatically write out the names
1164                  * onto our f_out socket as we read the file-list.  This
1165                  * avoids both deadlock and extra delays/buffers. */
1166                 start_filesfrom_forwarding(filesfrom_fd);
1167                 filesfrom_fd = -1;
1168         }
1169
1170         flist = recv_file_list(f_in, -1);
1171         if (!flist) {
1172                 rprintf(FERROR,"server_recv: recv_file_list error\n");
1173                 exit_cleanup(RERR_FILESELECT);
1174         }
1175         if (inc_recurse && file_total == 1)
1176                 recv_additional_file_list(f_in);
1177
1178         if (negated_levels)
1179                 negate_output_levels();
1180
1181         if (argc > 0)
1182                 local_name = get_local_name(flist,argv[0]);
1183
1184         /* Now that we know what our destination directory turned out to be,
1185          * we can sanitize the --link-/copy-/compare-dest args correctly. */
1186         if (sanitize_paths) {
1187                 char **dir_p;
1188                 for (dir_p = basis_dir; *dir_p; dir_p++)
1189                         *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1190                 if (partial_dir)
1191                         partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1192         }
1193         check_alt_basis_dirs();
1194
1195         if (daemon_filter_list.head) {
1196                 char **dir_p;
1197                 filter_rule_list *elp = &daemon_filter_list;
1198
1199                 for (dir_p = basis_dir; *dir_p; dir_p++) {
1200                         char *dir = *dir_p;
1201                         if (*dir == '/')
1202                                 dir += module_dirlen;
1203                         if (check_filter(elp, FLOG, dir, 1) < 0)
1204                                 goto options_rejected;
1205                 }
1206                 if (partial_dir && *partial_dir == '/'
1207                  && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1208                     options_rejected:
1209                         rprintf(FERROR, "Your options have been rejected by the server.\n");
1210                         exit_cleanup(RERR_SYNTAX);
1211                 }
1212         }
1213
1214         exit_code = do_recv(f_in, f_out, local_name);
1215         exit_cleanup(exit_code);
1216 }
1217
1218
1219 int child_main(int argc, char *argv[])
1220 {
1221         start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1222         return 0;
1223 }
1224
1225
1226 void start_server(int f_in, int f_out, int argc, char *argv[])
1227 {
1228         set_nonblocking(f_in);
1229         set_nonblocking(f_out);
1230
1231         io_set_sock_fds(f_in, f_out);
1232         setup_protocol(f_out, f_in);
1233
1234         if (protocol_version >= 23)
1235                 io_start_multiplex_out(f_out);
1236         if (am_daemon && io_timeout && protocol_version >= 31)
1237                 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1238
1239         if (am_sender) {
1240                 keep_dirlinks = 0; /* Must be disabled on the sender. */
1241                 if (need_messages_from_generator)
1242                         io_start_multiplex_in(f_in);
1243                 else
1244                         io_start_buffering_in(f_in);
1245                 recv_filter_list(f_in);
1246                 do_server_sender(f_in, f_out, argc, argv);
1247         } else
1248                 do_server_recv(f_in, f_out, argc, argv);
1249         exit_cleanup(0);
1250 }
1251
1252 /* This is called once the connection has been negotiated.  It is used
1253  * for rsyncd, remote-shell, and local connections. */
1254 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1255 {
1256         struct file_list *flist = NULL;
1257         int exit_code = 0, exit_code2 = 0;
1258         char *local_name = NULL;
1259
1260         cleanup_child_pid = pid;
1261         if (!read_batch) {
1262                 set_nonblocking(f_in);
1263                 set_nonblocking(f_out);
1264         }
1265
1266         io_set_sock_fds(f_in, f_out);
1267         setup_protocol(f_out,f_in);
1268
1269         /* We set our stderr file handle to blocking because ssh might have
1270          * set it to non-blocking.  This can be particularly troublesome if
1271          * stderr is a clone of stdout, because ssh would have set our stdout
1272          * to non-blocking at the same time (which can easily cause us to lose
1273          * output from our print statements).  This kluge shouldn't cause ssh
1274          * any problems for how we use it.  Note also that we delayed setting
1275          * this until after the above protocol setup so that we know for sure
1276          * that ssh is done twiddling its file descriptors.  */
1277         set_blocking(STDERR_FILENO);
1278
1279         if (am_sender) {
1280                 keep_dirlinks = 0; /* Must be disabled on the sender. */
1281
1282                 if (always_checksum
1283                  && (log_format_has(stdout_format, 'C')
1284                   || log_format_has(logfile_format, 'C')))
1285                         sender_keeps_checksum = 1;
1286
1287                 if (protocol_version >= 30)
1288                         io_start_multiplex_out(f_out);
1289                 else
1290                         io_start_buffering_out(f_out);
1291                 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1292                         io_start_multiplex_in(f_in);
1293                 else
1294                         io_start_buffering_in(f_in);
1295                 send_filter_list(f_out);
1296                 if (filesfrom_host)
1297                         filesfrom_fd = f_in;
1298
1299                 if (write_batch && !am_server)
1300                         start_write_batch(f_out);
1301
1302                 become_copy_as_user();
1303
1304                 flist = send_file_list(f_out, argc, argv);
1305                 if (DEBUG_GTE(FLIST, 3))
1306                         rprintf(FINFO,"file list sent\n");
1307
1308                 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1309                         io_start_multiplex_in(f_in);
1310
1311                 io_flush(NORMAL_FLUSH);
1312                 send_files(f_in, f_out);
1313                 io_flush(FULL_FLUSH);
1314                 handle_stats(-1);
1315                 if (protocol_version >= 24)
1316                         read_final_goodbye(f_in, f_out);
1317                 if (pid != -1) {
1318                         if (DEBUG_GTE(EXIT, 2))
1319                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1320                         io_flush(FULL_FLUSH);
1321                         wait_process_with_flush(pid, &exit_code);
1322                 }
1323                 output_summary();
1324                 io_flush(FULL_FLUSH);
1325                 exit_cleanup(exit_code);
1326         }
1327
1328         if (!read_batch) {
1329                 if (protocol_version >= 23)
1330                         io_start_multiplex_in(f_in);
1331                 if (need_messages_from_generator)
1332                         io_start_multiplex_out(f_out);
1333                 else
1334                         io_start_buffering_out(f_out);
1335         }
1336
1337         become_copy_as_user();
1338
1339         send_filter_list(read_batch ? -1 : f_out);
1340
1341         if (filesfrom_fd >= 0) {
1342                 start_filesfrom_forwarding(filesfrom_fd);
1343                 filesfrom_fd = -1;
1344         }
1345
1346         if (write_batch && !am_server)
1347                 start_write_batch(f_in);
1348         flist = recv_file_list(f_in, -1);
1349         if (inc_recurse && file_total == 1)
1350                 recv_additional_file_list(f_in);
1351
1352         if (flist && flist->used > 0) {
1353                 local_name = get_local_name(flist, argv[0]);
1354
1355                 check_alt_basis_dirs();
1356
1357                 exit_code2 = do_recv(f_in, f_out, local_name);
1358         } else {
1359                 handle_stats(-1);
1360                 output_summary();
1361         }
1362
1363         if (pid != -1) {
1364                 if (DEBUG_GTE(RECV, 1))
1365                         rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1366                 io_flush(FULL_FLUSH);
1367                 wait_process_with_flush(pid, &exit_code);
1368         }
1369
1370         return MAX(exit_code, exit_code2);
1371 }
1372
1373 static void dup_argv(char *argv[])
1374 {
1375         int i;
1376
1377         for (i = 0; argv[i]; i++)
1378                 argv[i] = strdup(argv[i]);
1379 }
1380
1381
1382 /* Start a client for either type of remote connection.  Work out
1383  * whether the arguments request a remote shell or rsyncd connection,
1384  * and call the appropriate connection function, then run_client.
1385  *
1386  * Calls either start_socket_client (for sockets) or do_cmd and
1387  * client_run (for ssh). */
1388 static int start_client(int argc, char *argv[])
1389 {
1390         char *p, *shell_machine = NULL, *shell_user = NULL;
1391         char **remote_argv;
1392         int remote_argc, env_port = rsync_port;
1393         int f_in, f_out;
1394         int ret;
1395         pid_t pid;
1396
1397         /* Don't clobber argv[] so that ps(1) can still show the right
1398          * command line. */
1399         dup_argv(argv);
1400
1401         if (!read_batch) { /* for read_batch, NO source is specified */
1402                 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1403                 if (path) { /* source is remote */
1404                         char *dummy_host;
1405                         int dummy_port = 0;
1406                         *argv = path;
1407                         remote_argv = argv;
1408                         remote_argc = argc;
1409                         argv += argc - 1;
1410                         if (argc == 1 || **argv == ':')
1411                                 argc = 0; /* no dest arg */
1412                         else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1413                                 rprintf(FERROR,
1414                                         "The source and destination cannot both be remote.\n");
1415                                 exit_cleanup(RERR_SYNTAX);
1416                         } else {
1417                                 remote_argc--; /* don't count dest */
1418                                 argc = 1;
1419                         }
1420                         if (filesfrom_host && *filesfrom_host && strcmp(filesfrom_host, shell_machine) != 0) {
1421                                 rprintf(FERROR,
1422                                         "--files-from hostname is not the same as the transfer hostname\n");
1423                                 exit_cleanup(RERR_SYNTAX);
1424                         }
1425                         am_sender = 0;
1426                         if (rsync_port)
1427                                 daemon_connection = shell_cmd ? 1 : -1;
1428                 } else { /* source is local, check dest arg */
1429                         am_sender = 1;
1430
1431                         if (argc > 1) {
1432                                 p = argv[--argc];
1433                                 remote_argv = argv + argc;
1434                         } else {
1435                                 static char *dotarg[1] = { "." };
1436                                 p = dotarg[0];
1437                                 remote_argv = dotarg;
1438                         }
1439                         remote_argc = 1;
1440
1441                         path = check_for_hostspec(p, &shell_machine, &rsync_port);
1442                         if (path && filesfrom_host && *filesfrom_host && strcmp(filesfrom_host, shell_machine) != 0) {
1443                                 rprintf(FERROR,
1444                                         "--files-from hostname is not the same as the transfer hostname\n");
1445                                 exit_cleanup(RERR_SYNTAX);
1446                         }
1447                         if (!path) { /* no hostspec found, so src & dest are local */
1448                                 local_server = 1;
1449                                 if (filesfrom_host) {
1450                                         rprintf(FERROR,
1451                                                 "--files-from cannot be remote when the transfer is local\n");
1452                                         exit_cleanup(RERR_SYNTAX);
1453                                 }
1454                                 shell_machine = NULL;
1455                                 rsync_port = 0;
1456                         } else { /* hostspec was found, so dest is remote */
1457                                 argv[argc] = path;
1458                                 if (rsync_port)
1459                                         daemon_connection = shell_cmd ? 1 : -1;
1460                         }
1461                 }
1462         } else {  /* read_batch */
1463                 local_server = 1;
1464                 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1465                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1466                         exit_cleanup(RERR_SYNTAX);
1467                 }
1468                 remote_argv = argv += argc - 1;
1469                 remote_argc = argc = 1;
1470                 rsync_port = 0;
1471         }
1472
1473         if (!rsync_port && remote_argc && !**remote_argv) /* Turn an empty arg into a dot dir. */
1474                 *remote_argv = ".";
1475
1476         if (am_sender) {
1477                 char *dummy_host;
1478                 int dummy_port = rsync_port;
1479                 int i;
1480                 if (!argv[0][0])
1481                         goto invalid_empty;
1482                 /* For local source, extra source args must not have hostspec. */
1483                 for (i = 1; i < argc; i++) {
1484                         if (!argv[i][0]) {
1485                             invalid_empty:
1486                                 rprintf(FERROR, "Empty source arg specified.\n");
1487                                 exit_cleanup(RERR_SYNTAX);
1488                         }
1489                         if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1490                                 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1491                                 exit_cleanup(RERR_SYNTAX);
1492                         }
1493                 }
1494         } else {
1495                 char *dummy_host;
1496                 int dummy_port = rsync_port;
1497                 int i;
1498                 /* For remote source, any extra source args must have either
1499                  * the same hostname or an empty hostname. */
1500                 for (i = 1; i < remote_argc; i++) {
1501                         char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1502                         if (!arg) {
1503                                 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1504                                 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1505                                 exit_cleanup(RERR_SYNTAX);
1506                         }
1507                         if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1508                                 rprintf(FERROR, "All source args must come from the same machine.\n");
1509                                 exit_cleanup(RERR_SYNTAX);
1510                         }
1511                         if (rsync_port != dummy_port) {
1512                                 if (!rsync_port || !dummy_port)
1513                                         rprintf(FERROR, "All source args must use the same hostspec format.\n");
1514                                 else
1515                                         rprintf(FERROR, "All source args must use the same port number.\n");
1516                                 exit_cleanup(RERR_SYNTAX);
1517                         }
1518                         if (!rsync_port && !*arg) /* Turn an empty arg into a dot dir. */
1519                                 arg = ".";
1520                         remote_argv[i] = arg;
1521                 }
1522         }
1523
1524         if (rsync_port < 0)
1525                 rsync_port = RSYNC_PORT;
1526         else
1527                 env_port = rsync_port;
1528
1529         if (daemon_connection < 0)
1530                 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1531
1532         if (password_file && !daemon_connection) {
1533                 rprintf(FERROR, "The --password-file option may only be "
1534                                 "used when accessing an rsync daemon.\n");
1535                 exit_cleanup(RERR_SYNTAX);
1536         }
1537
1538         if (connect_timeout) {
1539                 rprintf(FERROR, "The --contimeout option may only be "
1540                                 "used when connecting to an rsync daemon.\n");
1541                 exit_cleanup(RERR_SYNTAX);
1542         }
1543
1544         if (shell_machine) {
1545                 p = strrchr(shell_machine,'@');
1546                 if (p) {
1547                         *p = 0;
1548                         shell_user = shell_machine;
1549                         shell_machine = p+1;
1550                 }
1551         }
1552
1553         if (DEBUG_GTE(CMD, 2)) {
1554                 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1555                         NS(shell_cmd), NS(shell_machine), NS(shell_user),
1556                         NS(remote_argv[0]));
1557         }
1558
1559 #ifdef HAVE_PUTENV
1560         if (daemon_connection)
1561                 set_env_num("RSYNC_PORT", env_port);
1562 #else
1563         (void)env_port;
1564 #endif
1565
1566         pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc, &f_in, &f_out);
1567
1568         /* if we're running an rsync server on the remote host over a
1569          * remote shell command, we need to do the RSYNCD protocol first */
1570         if (daemon_connection) {
1571                 int tmpret;
1572                 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1573                 if (tmpret < 0)
1574                         return tmpret;
1575         }
1576
1577         ret = client_run(f_in, f_out, pid, argc, argv);
1578
1579         fflush(stdout);
1580         fflush(stderr);
1581
1582         return ret;
1583 }
1584
1585
1586 static void sigusr1_handler(UNUSED(int val))
1587 {
1588         called_from_signal_handler = 1;
1589         exit_cleanup(RERR_SIGNAL1);
1590 }
1591
1592 static void sigusr2_handler(UNUSED(int val))
1593 {
1594         if (!am_server)
1595                 output_summary();
1596         close_all();
1597         if (got_xfer_error)
1598                 _exit(RERR_PARTIAL);
1599         _exit(0);
1600 }
1601
1602 #if defined SIGINFO || defined SIGVTALRM
1603 static void siginfo_handler(UNUSED(int val))
1604 {
1605         if (!am_server && !INFO_GTE(PROGRESS, 1))
1606                 want_progress_now = True;
1607 }
1608 #endif
1609
1610 void remember_children(UNUSED(int val))
1611 {
1612 #ifdef WNOHANG
1613         int cnt, status;
1614         pid_t pid;
1615         /* An empty waitpid() loop was put here by Tridge and we could never
1616          * get him to explain why he put it in, so rather than taking it
1617          * out we're instead saving the child exit statuses for later use.
1618          * The waitpid() loop presumably eliminates all possibility of leaving
1619          * zombie children, maybe that's why he did it. */
1620         while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1621                 /* save the child's exit status */
1622                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1623                         if (pid_stat_table[cnt].pid == 0) {
1624                                 pid_stat_table[cnt].pid = pid;
1625                                 pid_stat_table[cnt].status = status;
1626                                 break;
1627                         }
1628                 }
1629         }
1630 #endif
1631 #ifndef HAVE_SIGACTION
1632         signal(SIGCHLD, remember_children);
1633 #endif
1634 }
1635
1636 /**
1637  * This routine catches signals and tries to send them to gdb.
1638  *
1639  * Because it's called from inside a signal handler it ought not to
1640  * use too many library routines.
1641  *
1642  * @todo Perhaps use "screen -X" instead/as well, to help people
1643  * debugging without easy access to X.  Perhaps use an environment
1644  * variable, or just call a script?
1645  *
1646  * @todo The /proc/ magic probably only works on Linux (and
1647  * Solaris?)  Can we be more portable?
1648  **/
1649 #ifdef MAINTAINER_MODE
1650 const char *get_panic_action(void)
1651 {
1652         const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1653
1654         if (cmd_fmt)
1655                 return cmd_fmt;
1656         return "xterm -display :0 -T Panic -n Panic -e gdb /proc/%d/exe %d";
1657 }
1658
1659 /**
1660  * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1661  *
1662  * This signal handler is only installed if we were configured with
1663  * --enable-maintainer-mode.  Perhaps it should always be on and we
1664  * should just look at the environment variable, but I'm a bit leery
1665  * of a signal sending us into a busy loop.
1666  **/
1667 static void rsync_panic_handler(UNUSED(int whatsig))
1668 {
1669         char cmd_buf[300];
1670         int ret, pid_int = getpid();
1671
1672         snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(), pid_int, pid_int);
1673
1674         /* Unless we failed to execute gdb, we allow the process to
1675          * continue.  I'm not sure if that's right. */
1676         ret = shell_exec(cmd_buf);
1677         if (ret)
1678                 _exit(ret);
1679 }
1680 #endif
1681
1682 static void unset_env_var(const char *var)
1683 {
1684 #ifdef HAVE_UNSETENV
1685         unsetenv(var);
1686 #else
1687 #ifdef HAVE_PUTENV
1688         char *mem;
1689         if (asprintf(&mem, "%s=", var) < 0)
1690                 out_of_memory("unset_env_var");
1691         putenv(mem);
1692 #else
1693         (void)var;
1694 #endif
1695 #endif
1696 }
1697
1698
1699 int main(int argc,char *argv[])
1700 {
1701         int ret;
1702
1703         raw_argc = argc;
1704         raw_argv = argv;
1705
1706 #ifdef HAVE_SIGACTION
1707 # ifdef HAVE_SIGPROCMASK
1708         sigset_t sigmask;
1709
1710         sigemptyset(&sigmask);
1711 # endif
1712         sigact.sa_flags = SA_NOCLDSTOP;
1713 #endif
1714         SIGACTMASK(SIGUSR1, sigusr1_handler);
1715         SIGACTMASK(SIGUSR2, sigusr2_handler);
1716         SIGACTMASK(SIGCHLD, remember_children);
1717 #ifdef MAINTAINER_MODE
1718         SIGACTMASK(SIGSEGV, rsync_panic_handler);
1719         SIGACTMASK(SIGFPE, rsync_panic_handler);
1720         SIGACTMASK(SIGABRT, rsync_panic_handler);
1721         SIGACTMASK(SIGBUS, rsync_panic_handler);
1722 #endif
1723 #ifdef SIGINFO
1724         SIGACTMASK(SIGINFO, siginfo_handler);
1725 #endif
1726 #ifdef SIGVTALRM
1727         SIGACTMASK(SIGVTALRM, siginfo_handler);
1728 #endif
1729
1730         starttime = time(NULL);
1731         our_uid = MY_UID();
1732         our_gid = MY_GID();
1733         am_root = our_uid == ROOT_UID;
1734
1735         unset_env_var("DISPLAY");
1736
1737         memset(&stats, 0, sizeof(stats));
1738
1739         /* Even a non-daemon runs needs the default config values to be set, e.g.
1740          * lp_dont_compress() is queried when no --skip-compress option is set. */
1741         reset_daemon_vars();
1742
1743         if (argc < 2) {
1744                 usage(FERROR);
1745                 exit_cleanup(RERR_SYNTAX);
1746         }
1747
1748         /* Get the umask for use in permission calculations.  We no longer set
1749          * it to zero; that is ugly and pointless now that all the callers that
1750          * relied on it have been reeducated to work with default ACLs. */
1751         umask(orig_umask = umask(0));
1752
1753 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1754         setlocale(LC_CTYPE, "");
1755         setlocale(LC_NUMERIC, "");
1756 #endif
1757
1758         if (!parse_arguments(&argc, (const char ***) &argv)) {
1759                 option_error();
1760                 exit_cleanup(RERR_SYNTAX);
1761         }
1762         if (write_batch
1763          && poptDupArgv(argc, (const char **)argv, &cooked_argc, (const char ***)&cooked_argv) != 0)
1764                 out_of_memory("main");
1765
1766         SIGACTMASK(SIGINT, sig_int);
1767         SIGACTMASK(SIGHUP, sig_int);
1768         SIGACTMASK(SIGTERM, sig_int);
1769 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1770         sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1771 #endif
1772
1773         /* Ignore SIGPIPE; we consistently check error codes and will
1774          * see the EPIPE. */
1775         SIGACTION(SIGPIPE, SIG_IGN);
1776 #ifdef SIGXFSZ
1777         SIGACTION(SIGXFSZ, SIG_IGN);
1778 #endif
1779
1780         /* Initialize change_dir() here because on some old systems getcwd
1781          * (implemented by forking "pwd" and reading its output) doesn't
1782          * work when there are other child processes.  Also, on all systems
1783          * that implement getcwd that way "pwd" can't be found after chroot. */
1784         change_dir(NULL, CD_NORMAL);
1785
1786         if ((write_batch || read_batch) && !am_server) {
1787                 open_batch_files(); /* sets batch_fd */
1788                 if (read_batch)
1789                         read_stream_flags(batch_fd);
1790                 else
1791                         write_stream_flags(batch_fd);
1792         }
1793         if (write_batch < 0)
1794                 dry_run = 1;
1795
1796         if (am_server) {
1797 #ifdef ICONV_CONST
1798                 setup_iconv();
1799 #endif
1800         } else if (am_daemon)
1801                 return daemon_main();
1802
1803         if (am_server && protect_args) {
1804                 char buf[MAXPATHLEN];
1805                 protect_args = 2;
1806                 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1807                 if (!parse_arguments(&argc, (const char ***) &argv)) {
1808                         option_error();
1809                         exit_cleanup(RERR_SYNTAX);
1810                 }
1811         }
1812
1813         if (argc < 1) {
1814                 usage(FERROR);
1815                 exit_cleanup(RERR_SYNTAX);
1816         }
1817
1818         if (am_server) {
1819                 set_nonblocking(STDIN_FILENO);
1820                 set_nonblocking(STDOUT_FILENO);
1821                 if (am_daemon)
1822                         return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1823                 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1824         }
1825
1826         ret = start_client(argc, argv);
1827         if (ret == -1)
1828                 exit_cleanup(RERR_STARTCLIENT);
1829         else
1830                 exit_cleanup(ret);
1831
1832         return ret;
1833 }