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 old_style_args;
  52 extern int msgs2stderr;
  53 extern int module_id;
  54 extern int read_only;
  55 extern int copy_links;
  56 extern int copy_dirlinks;
  57 extern int copy_unsafe_links;
  58 extern int keep_dirlinks;
  59 extern int preserve_hard_links;
  60 extern int protocol_version;
  61 extern int mkpath_dest_arg;
  62 extern int file_total;
  63 extern int recurse;
  64 extern int xfer_dirs;
  65 extern int protect_args;
  66 extern int relative_paths;
  67 extern int sanitize_paths;
  68 extern int curr_dir_depth;
  69 extern int curr_dir_len;
  70 extern int module_id;
  71 extern int rsync_port;
  72 extern int whole_file;
  73 extern int read_batch;
  74 extern int write_batch;
  75 extern int batch_fd;
  76 extern int sock_f_in;
  77 extern int sock_f_out;
  78 extern int filesfrom_fd;
  79 extern int connect_timeout;
  80 extern int send_msgs_to_gen;
  81 extern dev_t filesystem_dev;
  82 extern pid_t cleanup_child_pid;
  83 extern size_t bwlimit_writemax;
  84 extern unsigned int module_dirlen;
  85 extern BOOL flist_receiving_enabled;
  86 extern BOOL want_progress_now;
  87 extern BOOL shutting_down;
  88 extern int backup_dir_len;
  89 extern int basis_dir_cnt;
  90 extern int default_af_hint;
  91 extern int stdout_format_has_i;
  92 extern struct stats stats;
  93 extern char *stdout_format;
  94 extern char *logfile_format;
  95 extern char *filesfrom_host;
  96 extern char *partial_dir;
  97 extern char *rsync_path;
  98 extern char *shell_cmd;
  99 extern char *password_file;
 100 extern char *backup_dir;
 101 extern char *copy_as;
 102 extern char *tmpdir;
 103 extern char curr_dir[MAXPATHLEN];
 104 extern char backup_dir_buf[MAXPATHLEN];
 105 extern char *basis_dir[MAX_BASIS_DIRS+1];
 106 extern struct file_list *first_flist;
 107 extern filter_rule_list daemon_filter_list, implied_filter_list;
 108
 109 uid_t our_uid;
 110 gid_t our_gid;
 111 int am_receiver = 0;  /* Only set to 1 after the receiver/generator fork. */
 112 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
 113 int local_server = 0;
 114 int daemon_connection = 0; /* 0 = no daemon, 1 = daemon via remote shell, -1 = daemon via socket */
 115 mode_t orig_umask = 0;
 116 int batch_gen_fd = -1;
 117 int sender_keeps_checksum = 0;
 118 int raw_argc, cooked_argc;
 119 char **raw_argv, **cooked_argv;
 120
 121 /* There's probably never more than at most 2 outstanding child processes,
 122  * but set it higher, just in case. */
 123 #define MAXCHILDPROCS 7
 124
 125 #ifdef HAVE_SIGACTION
 126 # ifdef HAVE_SIGPROCMASK
 127 #  define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
 128 # else
 129 #  define SIGACTMASK(n,h) SIGACTION(n,h)
 130 # endif
 131 static struct sigaction sigact;
 132 #endif
 133
 134 struct pid_status {
 135         pid_t pid;
 136         int status;
 137 } pid_stat_table[MAXCHILDPROCS];
 138
 139 static time_t starttime, endtime;
 140 static int64 total_read, total_written;
 141
 142 static void show_malloc_stats(void);
 143
 144 /* Works like waitpid(), but if we already harvested the child pid in our
 145  * remember_children(), we succeed instead of returning an error. */
 146 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
 147 {
 148         pid_t waited_pid;
 149
 150         do {
 151                 waited_pid = waitpid(pid, status_ptr, flags);
 152         } while (waited_pid == -1 && errno == EINTR);
 153
 154         if (waited_pid == -1 && errno == ECHILD) {
 155                 /* Status of requested child no longer available:  check to
 156                  * see if it was processed by remember_children(). */
 157                 int cnt;
 158                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
 159                         if (pid == pid_stat_table[cnt].pid) {
 160                                 *status_ptr = pid_stat_table[cnt].status;
 161                                 pid_stat_table[cnt].pid = 0;
 162                                 return pid;
 163                         }
 164                 }
 165         }
 166
 167         return waited_pid;
 168 }
 169
 170 int shell_exec(const char *cmd)
 171 {
 172         char *shell = getenv("RSYNC_SHELL");
 173         int status;
 174         pid_t pid;
 175
 176         if (!shell)
 177                 return system(cmd);
 178
 179         if ((pid = fork()) < 0)
 180                 return -1;
 181
 182         if (pid == 0) {
 183                 execlp(shell, shell, "-c", cmd, NULL);
 184                 _exit(1);
 185         }
 186
 187         int ret = wait_process(pid, &status, 0);
 188         return ret < 0 ? -1 : status;
 189 }
 190
 191 /* Wait for a process to exit, calling io_flush while waiting. */
 192 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
 193 {
 194         pid_t waited_pid;
 195         int status;
 196
 197         while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
 198                 msleep(20);
 199                 io_flush(FULL_FLUSH);
 200         }
 201
 202         /* TODO: If the child exited on a signal, then log an
 203          * appropriate error message.  Perhaps we should also accept a
 204          * message describing the purpose of the child.  Also indicate
 205          * this to the caller so that they know something went wrong. */
 206         if (waited_pid < 0) {
 207                 rsyserr(FERROR, errno, "waitpid");
 208                 *exit_code_ptr = RERR_WAITCHILD;
 209         } else if (!WIFEXITED(status)) {
 210 #ifdef WCOREDUMP
 211                 if (WCOREDUMP(status))
 212                         *exit_code_ptr = RERR_CRASHED;
 213                 else
 214 #endif
 215                 if (WIFSIGNALED(status))
 216                         *exit_code_ptr = RERR_TERMINATED;
 217                 else
 218                         *exit_code_ptr = RERR_WAITCHILD;
 219         } else
 220                 *exit_code_ptr = WEXITSTATUS(status);
 221 }
 222
 223 void write_del_stats(int f)
 224 {
 225         if (read_batch)
 226                 write_int(f, NDX_DEL_STATS);
 227         else
 228                 write_ndx(f, NDX_DEL_STATS);
 229         write_varint(f, stats.deleted_files - stats.deleted_dirs
 230                       - stats.deleted_symlinks - stats.deleted_devices
 231                       - stats.deleted_specials);
 232         write_varint(f, stats.deleted_dirs);
 233         write_varint(f, stats.deleted_symlinks);
 234         write_varint(f, stats.deleted_devices);
 235         write_varint(f, stats.deleted_specials);
 236 }
 237
 238 void read_del_stats(int f)
 239 {
 240         stats.deleted_files = read_varint(f);
 241         stats.deleted_files += stats.deleted_dirs = read_varint(f);
 242         stats.deleted_files += stats.deleted_symlinks = read_varint(f);
 243         stats.deleted_files += stats.deleted_devices = read_varint(f);
 244         stats.deleted_files += stats.deleted_specials = read_varint(f);
 245 }
 246
 247 static void become_copy_as_user()
 248 {
 249         char *gname;
 250         uid_t uid;
 251         gid_t gid;
 252
 253         if (!copy_as)
 254                 return;
 255
 256         if (DEBUG_GTE(CMD, 2))
 257                 rprintf(FINFO, "[%s] copy_as=%s\n", who_am_i(), copy_as);
 258
 259         if ((gname = strchr(copy_as, ':')) != NULL)
 260                 *gname++ = '\0';
 261
 262         if (!user_to_uid(copy_as, &uid, True)) {
 263                 rprintf(FERROR, "Invalid copy-as user: %s\n", copy_as);
 264                 exit_cleanup(RERR_SYNTAX);
 265         }
 266
 267         if (gname) {
 268                 if (!group_to_gid(gname, &gid, True)) {
 269                         rprintf(FERROR, "Invalid copy-as group: %s\n", gname);
 270                         exit_cleanup(RERR_SYNTAX);
 271                 }
 272         } else {
 273                 struct passwd *pw;
 274                 if ((pw = getpwuid(uid)) == NULL) {
 275                         rsyserr(FERROR, errno, "getpwuid failed");
 276                         exit_cleanup(RERR_SYNTAX);
 277                 }
 278                 gid = pw->pw_gid;
 279         }
 280
 281         if (setgid(gid) < 0) {
 282                 rsyserr(FERROR, errno, "setgid failed");
 283                 exit_cleanup(RERR_SYNTAX);
 284         }
 285 #ifdef HAVE_SETGROUPS
 286         if (setgroups(1, &gid)) {
 287                 rsyserr(FERROR, errno, "setgroups failed");
 288                 exit_cleanup(RERR_SYNTAX);
 289         }
 290 #endif
 291 #ifdef HAVE_INITGROUPS
 292         if (!gname && initgroups(copy_as, gid) < 0) {
 293                 rsyserr(FERROR, errno, "initgroups failed");
 294                 exit_cleanup(RERR_SYNTAX);
 295         }
 296 #endif
 297
 298         if (setuid(uid) < 0
 299 #ifdef HAVE_SETEUID
 300          || seteuid(uid) < 0
 301 #endif
 302         ) {
 303                 rsyserr(FERROR, errno, "setuid failed");
 304                 exit_cleanup(RERR_SYNTAX);
 305         }
 306
 307         our_uid = MY_UID();
 308         our_gid = MY_GID();
 309         am_root = (our_uid == ROOT_UID);
 310
 311         if (gname)
 312                 gname[-1] = ':';
 313 }
 314
 315 /* This function gets called from all 3 processes.  We want the client side
 316  * to actually output the text, but the sender is the only process that has
 317  * all the stats we need.  So, if we're a client sender, we do the report.
 318  * If we're a server sender, we write the stats on the supplied fd.  If
 319  * we're the client receiver we read the stats from the supplied fd and do
 320  * the report.  All processes might also generate a set of debug stats, if
 321  * the verbose level is high enough (this is the only thing that the
 322  * generator process and the server receiver ever do here). */
 323 static void handle_stats(int f)
 324 {
 325         endtime = time(NULL);
 326
 327         /* Cache two stats because the read/write code can change it. */
 328         total_read = stats.total_read;
 329         total_written = stats.total_written;
 330
 331         if (INFO_GTE(STATS, 3)) {
 332                 /* These come out from every process */
 333                 show_malloc_stats();
 334                 show_flist_stats();
 335         }
 336
 337         if (am_generator)
 338                 return;
 339
 340         if (am_daemon) {
 341                 if (f == -1 || !am_sender)
 342                         return;
 343         }
 344
 345         if (am_server) {
 346                 if (am_sender) {
 347                         write_varlong30(f, total_read, 3);
 348                         write_varlong30(f, total_written, 3);
 349                         write_varlong30(f, stats.total_size, 3);
 350                         if (protocol_version >= 29) {
 351                                 write_varlong30(f, stats.flist_buildtime, 3);
 352                                 write_varlong30(f, stats.flist_xfertime, 3);
 353                         }
 354                 }
 355                 return;
 356         }
 357
 358         /* this is the client */
 359
 360         if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
 361                 ;
 362         else if (!am_sender) {
 363                 /* Read the first two in opposite order because the meaning of
 364                  * read/write swaps when switching from sender to receiver. */
 365                 total_written = read_varlong30(f, 3);
 366                 total_read = read_varlong30(f, 3);
 367                 stats.total_size = read_varlong30(f, 3);
 368                 if (protocol_version >= 29) {
 369                         stats.flist_buildtime = read_varlong30(f, 3);
 370                         stats.flist_xfertime = read_varlong30(f, 3);
 371                 }
 372         } else if (write_batch) {
 373                 /* The --read-batch process is going to be a client
 374                  * receiver, so we need to give it the stats. */
 375                 write_varlong30(batch_fd, total_read, 3);
 376                 write_varlong30(batch_fd, total_written, 3);
 377                 write_varlong30(batch_fd, stats.total_size, 3);
 378                 if (protocol_version >= 29) {
 379                         write_varlong30(batch_fd, stats.flist_buildtime, 3);
 380                         write_varlong30(batch_fd, stats.flist_xfertime, 3);
 381                 }
 382         }
 383 }
 384
 385 static void output_itemized_counts(const char *prefix, int *counts)
 386 {
 387         static char *labels[] = { "reg", "dir", "link", "dev", "special" };
 388         char buf[1024], *pre = " (";
 389         int j, len = 0;
 390         int total = counts[0];
 391         if (total) {
 392                 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
 393                 for (j = 0; j < 5; j++) {
 394                         if (counts[j]) {
 395                                 len += snprintf(buf+len, sizeof buf - len - 2,
 396                                         "%s%s: %s",
 397                                         pre, labels[j], comma_num(counts[j]));
 398                                 pre = ", ";
 399                         }
 400                 }
 401                 buf[len++] = ')';
 402         }
 403         buf[len] = '\0';
 404         rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
 405 }
 406
 407 static const char *bytes_per_sec_human_dnum(void)
 408 {
 409         if (starttime == (time_t)-1 || endtime == (time_t)-1)
 410                 return "UNKNOWN";
 411         return human_dnum((total_written + total_read) / (0.5 + (endtime - starttime)), 2);
 412 }
 413
 414 static void output_summary(void)
 415 {
 416         if (INFO_GTE(STATS, 2)) {
 417                 rprintf(FCLIENT, "\n");
 418                 output_itemized_counts("Number of files", &stats.num_files);
 419                 if (protocol_version >= 29)
 420                         output_itemized_counts("Number of created files", &stats.created_files);
 421                 if (protocol_version >= 31)
 422                         output_itemized_counts("Number of deleted files", &stats.deleted_files);
 423                 rprintf(FINFO,"Number of regular files transferred: %s\n",
 424                         comma_num(stats.xferred_files));
 425                 rprintf(FINFO,"Total file size: %s bytes\n",
 426                         human_num(stats.total_size));
 427                 rprintf(FINFO,"Total transferred file size: %s bytes\n",
 428                         human_num(stats.total_transferred_size));
 429                 rprintf(FINFO,"Literal data: %s bytes\n",
 430                         human_num(stats.literal_data));
 431                 rprintf(FINFO,"Matched data: %s bytes\n",
 432                         human_num(stats.matched_data));
 433                 rprintf(FINFO,"File list size: %s\n",
 434                         human_num(stats.flist_size));
 435                 if (stats.flist_buildtime) {
 436                         rprintf(FINFO,
 437                                 "File list generation time: %s seconds\n",
 438                                 comma_dnum((double)stats.flist_buildtime / 1000, 3));
 439                         rprintf(FINFO,
 440                                 "File list transfer time: %s seconds\n",
 441                                 comma_dnum((double)stats.flist_xfertime / 1000, 3));
 442                 }
 443                 rprintf(FINFO,"Total bytes sent: %s\n",
 444                         human_num(total_written));
 445                 rprintf(FINFO,"Total bytes received: %s\n",
 446                         human_num(total_read));
 447         }
 448
 449         if (INFO_GTE(STATS, 1)) {
 450                 rprintf(FCLIENT, "\n");
 451                 rprintf(FINFO,
 452                         "sent %s bytes  received %s bytes  %s bytes/sec\n",
 453                         human_num(total_written), human_num(total_read),
 454                         bytes_per_sec_human_dnum());
 455                 rprintf(FINFO, "total size is %s  speedup is %s%s\n",
 456                         human_num(stats.total_size),
 457                         comma_dnum((double)stats.total_size / (total_written+total_read), 2),
 458                         write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
 459         }
 460
 461         fflush(stdout);
 462         fflush(stderr);
 463 }
 464
 465
 466 /**
 467  * If our C library can get malloc statistics, then show them to FINFO
 468  **/
 469 static void show_malloc_stats(void)
 470 {
 471 #ifdef MEM_ALLOC_INFO
 472         struct MEM_ALLOC_INFO mi = MEM_ALLOC_INFO(); /* mallinfo or mallinfo2 */
 473
 474         rprintf(FCLIENT, "\n");
 475         rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
 476                 (int)getpid(), am_server ? "server " : "",
 477                 am_daemon ? "daemon " : "", who_am_i());
 478
 479 #define PRINT_ALLOC_NUM(title, descr, num) \
 480         rprintf(FINFO, "  %-11s%10" SIZE_T_FMT_MOD "d   (" descr ")\n", \
 481                 title ":", (SIZE_T_FMT_CAST)(num));
 482
 483         PRINT_ALLOC_NUM("arena", "bytes from sbrk", mi.arena);
 484         PRINT_ALLOC_NUM("ordblks", "chunks not in use", mi.ordblks);
 485         PRINT_ALLOC_NUM("smblks", "free fastbin blocks", mi.smblks);
 486         PRINT_ALLOC_NUM("hblks", "chunks from mmap", mi.hblks);
 487         PRINT_ALLOC_NUM("hblkhd", "bytes from mmap", mi.hblkhd);
 488         PRINT_ALLOC_NUM("allmem", "bytes from sbrk + mmap", mi.arena + mi.hblkhd);
 489         PRINT_ALLOC_NUM("usmblks", "always 0", mi.usmblks);
 490         PRINT_ALLOC_NUM("fsmblks", "bytes in freed fastbin blocks", mi.fsmblks);
 491         PRINT_ALLOC_NUM("uordblks", "bytes used", mi.uordblks);
 492         PRINT_ALLOC_NUM("fordblks", "bytes free", mi.fordblks);
 493         PRINT_ALLOC_NUM("keepcost", "bytes in releasable chunk", mi.keepcost);
 494
 495 #undef PRINT_ALLOC_NUM
 496
 497 #endif /* MEM_ALLOC_INFO */
 498 }
 499
 500
 501 /* Start the remote shell.   cmd may be NULL to use the default. */
 502 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
 503                     int *f_in_p, int *f_out_p)
 504 {
 505         int i, argc = 0;
 506         char *args[MAX_ARGS], *need_to_free = NULL;
 507         pid_t pid;
 508         int dash_l_set = 0;
 509
 510         if (!read_batch && !local_server) {
 511                 char *t, *f, in_quote = '\0';
 512                 char *rsh_env = getenv(RSYNC_RSH_ENV);
 513                 if (!cmd)
 514                         cmd = rsh_env;
 515                 if (!cmd)
 516                         cmd = RSYNC_RSH;
 517                 cmd = need_to_free = strdup(cmd);
 518
 519                 for (t = f = cmd; *f; f++) {
 520                         if (*f == ' ')
 521                                 continue;
 522                         /* Comparison leaves rooms for server_options(). */
 523                         if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
 524                                 goto arg_overflow;
 525                         args[argc++] = t;
 526                         while (*f != ' ' || in_quote) {
 527                                 if (!*f) {
 528                                         if (in_quote) {
 529                                                 rprintf(FERROR,
 530                                                         "Missing trailing-%c in remote-shell command.\n",
 531                                                         in_quote);
 532                                                 exit_cleanup(RERR_SYNTAX);
 533                                         }
 534                                         f--;
 535                                         break;
 536                                 }
 537                                 if (*f == '\'' || *f == '"') {
 538                                         if (!in_quote) {
 539                                                 in_quote = *f++;
 540                                                 continue;
 541                                         }
 542                                         if (*f == in_quote && *++f != in_quote) {
 543                                                 in_quote = '\0';
 544                                                 continue;
 545                                         }
 546                                 }
 547                                 *t++ = *f++;
 548                         }
 549                         *t++ = '\0';
 550                 }
 551
 552                 /* NOTE: must preserve t == start of command name until the end of the args handling! */
 553                 if ((t = strrchr(cmd, '/')) != NULL)
 554                         t++;
 555                 else
 556                         t = cmd;
 557
 558                 /* Check to see if we've already been given '-l user' in the remote-shell command. */
 559                 for (i = 0; i < argc-1; i++) {
 560                         if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
 561                                 dash_l_set = 1;
 562                 }
 563
 564 #ifdef HAVE_REMSH
 565                 /* remsh (on HPUX) takes the arguments the other way around */
 566                 args[argc++] = machine;
 567                 if (user && !(daemon_connection && dash_l_set)) {
 568                         args[argc++] = "-l";
 569                         args[argc++] = user;
 570                 }
 571 #else
 572                 if (user && !(daemon_connection && dash_l_set)) {
 573                         args[argc++] = "-l";
 574                         args[argc++] = user;
 575                 }
 576 #ifdef AF_INET
 577                 if (default_af_hint == AF_INET && strcmp(t, "ssh") == 0)
 578                         args[argc++] = "-4"; /* we're using ssh so we can add a -4 option */
 579 #endif
 580 #ifdef AF_INET6
 581                 if (default_af_hint == AF_INET6 && strcmp(t, "ssh") == 0)
 582                         args[argc++] = "-6"; /* we're using ssh so we can add a -6 option */
 583 #endif
 584                 args[argc++] = machine;
 585 #endif
 586
 587                 args[argc++] = rsync_path;
 588
 589                 if (blocking_io < 0 && (strcmp(t, "rsh") == 0 || strcmp(t, "remsh") == 0))
 590                         blocking_io = 1;
 591
 592                 if (daemon_connection > 0) {
 593                         args[argc++] = "--server";
 594                         args[argc++] = "--daemon";
 595                 } else
 596                         server_options(args, &argc);
 597
 598                 if (argc >= MAX_ARGS - 2)
 599                         goto arg_overflow;
 600         }
 601
 602         args[argc++] = ".";
 603
 604         if (!daemon_connection) {
 605                 while (remote_argc > 0) {
 606                         if (argc >= MAX_ARGS - 1) {
 607                           arg_overflow:
 608                                 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
 609                                 exit_cleanup(RERR_SYNTAX);
 610                         }
 611                         args[argc++] = safe_arg(NULL, *remote_argv++);
 612                         remote_argc--;
 613                 }
 614         }
 615
 616         args[argc] = NULL;
 617
 618         if (DEBUG_GTE(CMD, 2)) {
 619                 for (i = 0; i < argc; i++)
 620                         rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
 621                 rprintf(FCLIENT, "\n");
 622         }
 623
 624         if (read_batch) {
 625                 int from_gen_pipe[2];
 626                 set_allow_inc_recurse();
 627                 if (fd_pair(from_gen_pipe) < 0) {
 628                         rsyserr(FERROR, errno, "pipe");
 629                         exit_cleanup(RERR_IPC);
 630                 }
 631                 batch_gen_fd = from_gen_pipe[0];
 632                 *f_out_p = from_gen_pipe[1];
 633                 *f_in_p = batch_fd;
 634                 pid = (pid_t)-1; /* no child pid */
 635 #ifdef ICONV_CONST
 636                 setup_iconv();
 637 #endif
 638         } else if (local_server) {
 639                 /* If the user didn't request --[no-]whole-file, force
 640                  * it on, but only if we're not batch processing. */
 641                 if (whole_file < 0 && !write_batch)
 642                         whole_file = 1;
 643                 set_allow_inc_recurse();
 644                 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
 645 #ifdef ICONV_CONST
 646                 setup_iconv();
 647 #endif
 648         } else {
 649                 pid = piped_child(args, f_in_p, f_out_p);
 650 #ifdef ICONV_CONST
 651                 setup_iconv();
 652 #endif
 653                 if (protect_args && !daemon_connection)
 654                         send_protected_args(*f_out_p, args);
 655         }
 656
 657         if (need_to_free)
 658                 free(need_to_free);
 659
 660         return pid;
 661 }
 662
 663 /* The receiving side operates in one of two modes:
 664  *
 665  * 1. it receives any number of files into a destination directory,
 666  * placing them according to their names in the file-list.
 667  *
 668  * 2. it receives a single file and saves it using the name in the
 669  * destination path instead of its file-list name.  This requires a
 670  * "local name" for writing out the destination file.
 671  *
 672  * So, our task is to figure out what mode/local-name we need.
 673  * For mode 1, we change into the destination directory and return NULL.
 674  * For mode 2, we change into the directory containing the destination
 675  * file (if we aren't already there) and return the local-name. */
 676 static char *get_local_name(struct file_list *flist, char *dest_path)
 677 {
 678         STRUCT_STAT st;
 679         int statret, trailing_slash;
 680         char *cp;
 681
 682         if (DEBUG_GTE(RECV, 1)) {
 683                 rprintf(FINFO, "get_local_name count=%d %s\n",
 684                         file_total, NS(dest_path));
 685         }
 686
 687         if (!dest_path || list_only)
 688                 return NULL;
 689
 690         /* Treat an empty string as a copy into the current directory. */
 691         if (!*dest_path)
 692                 dest_path = ".";
 693
 694         if (daemon_filter_list.head) {
 695                 char *slash = strrchr(dest_path, '/');
 696                 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
 697                         *slash = '\0';
 698                 else
 699                         slash = NULL;
 700                 if ((*dest_path != '.' || dest_path[1] != '\0')
 701                  && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
 702                   || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
 703                         rprintf(FERROR, "ERROR: daemon has excluded destination \"%s\"\n",
 704                                 dest_path);
 705                         exit_cleanup(RERR_FILESELECT);
 706                 }
 707                 if (slash)
 708                         *slash = '/';
 709         }
 710
 711         /* See what currently exists at the destination. */
 712         statret = do_stat(dest_path, &st);
 713         cp = strrchr(dest_path, '/');
 714         trailing_slash = cp && !cp[1];
 715
 716         if (mkpath_dest_arg && statret < 0 && (cp || file_total > 1)) {
 717                 int save_errno = errno;
 718                 int ret = make_path(dest_path, file_total > 1 && !trailing_slash ? 0 : MKP_DROP_NAME);
 719                 if (ret < 0)
 720                         goto mkdir_error;
 721                 if (ret && (INFO_GTE(NAME, 1) || stdout_format_has_i)) {
 722                         if (file_total == 1 || trailing_slash)
 723                                 *cp = '\0';
 724                         rprintf(FINFO, "created %d director%s for %s\n", ret, ret == 1 ? "y" : "ies", dest_path);
 725                         if (file_total == 1 || trailing_slash)
 726                                 *cp = '/';
 727                 }
 728                 if (ret)
 729                         statret = do_stat(dest_path, &st);
 730                 else
 731                         errno = save_errno;
 732         }
 733
 734         if (statret == 0) {
 735                 /* If the destination is a dir, enter it and use mode 1. */
 736                 if (S_ISDIR(st.st_mode)) {
 737                         if (!change_dir(dest_path, CD_NORMAL)) {
 738                                 rsyserr(FERROR, errno, "change_dir#1 %s failed",
 739                                         full_fname(dest_path));
 740                                 exit_cleanup(RERR_FILESELECT);
 741                         }
 742                         filesystem_dev = st.st_dev; /* ensures --force works right w/-x */
 743                         return NULL;
 744                 }
 745                 if (file_total > 1) {
 746                         rprintf(FERROR,
 747                                 "ERROR: destination must be a directory when"
 748                                 " copying more than 1 file\n");
 749                         exit_cleanup(RERR_FILESELECT);
 750                 }
 751                 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
 752                         rprintf(FERROR,
 753                                 "ERROR: cannot overwrite non-directory"
 754                                 " with a directory\n");
 755                         exit_cleanup(RERR_FILESELECT);
 756                 }
 757         } else if (errno != ENOENT) {
 758                 /* If we don't know what's at the destination, fail. */
 759                 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
 760                         full_fname(dest_path));
 761                 exit_cleanup(RERR_FILESELECT);
 762         }
 763
 764         /* If we need a destination directory because the transfer is not
 765          * of a single non-directory or the user has requested one via a
 766          * destination path ending in a slash, create one and use mode 1. */
 767         if (file_total > 1 || trailing_slash) {
 768                 if (trailing_slash)
 769                         *cp = '\0'; /* Lop off the final slash (if any). */
 770
 771                 if (statret == 0) {
 772                         rprintf(FERROR, "ERROR: destination path is not a directory\n");
 773                         exit_cleanup(RERR_SYNTAX);
 774                 }
 775
 776                 if (do_mkdir(dest_path, ACCESSPERMS) != 0) {
 777                     mkdir_error:
 778                         rsyserr(FERROR, errno, "mkdir %s failed",
 779                                 full_fname(dest_path));
 780                         exit_cleanup(RERR_FILEIO);
 781                 }
 782
 783                 if (flist->high >= flist->low
 784                  && strcmp(flist->files[flist->low]->basename, ".") == 0)
 785                         flist->files[0]->flags |= FLAG_DIR_CREATED;
 786
 787                 if (INFO_GTE(NAME, 1) || stdout_format_has_i)
 788                         rprintf(FINFO, "created directory %s\n", dest_path);
 789
 790                 if (dry_run) {
 791                         /* Indicate that dest dir doesn't really exist. */
 792                         dry_run++;
 793                 }
 794
 795                 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
 796                         rsyserr(FERROR, errno, "change_dir#2 %s failed",
 797                                 full_fname(dest_path));
 798                         exit_cleanup(RERR_FILESELECT);
 799                 }
 800
 801                 return NULL;
 802         }
 803
 804         /* Otherwise, we are writing a single file, possibly on top of an
 805          * existing non-directory.  Change to the item's parent directory
 806          * (if it has a path component), return the basename of the
 807          * destination file as the local name, and use mode 2. */
 808         if (!cp)
 809                 return dest_path;
 810
 811         if (cp == dest_path)
 812                 dest_path = "/";
 813
 814         *cp = '\0';
 815         if (!change_dir(dest_path, CD_NORMAL)) {
 816                 rsyserr(FERROR, errno, "change_dir#3 %s failed",
 817                         full_fname(dest_path));
 818                 exit_cleanup(RERR_FILESELECT);
 819         }
 820         *cp = '/';
 821
 822         return cp + 1;
 823 }
 824
 825 /* This function checks on our alternate-basis directories.  If we're in
 826  * dry-run mode and the destination dir does not yet exist, we'll try to
 827  * tweak any dest-relative paths to make them work for a dry-run (the
 828  * destination dir must be in curr_dir[] when this function is called).
 829  * We also warn about any arg that is non-existent or not a directory. */
 830 static void check_alt_basis_dirs(void)
 831 {
 832         STRUCT_STAT st;
 833         char *slash = strrchr(curr_dir, '/');
 834         int j;
 835
 836         for (j = 0; j < basis_dir_cnt; j++) {
 837                 char *bdir = basis_dir[j];
 838                 int bd_len = strlen(bdir);
 839                 if (bd_len > 1 && bdir[bd_len-1] == '/')
 840                         bdir[--bd_len] = '\0';
 841                 if (dry_run > 1 && *bdir != '/') {
 842                         int len = curr_dir_len + 1 + bd_len + 1;
 843                         char *new = new_array(char, len);
 844                         if (slash && strncmp(bdir, "../", 3) == 0) {
 845                                 /* We want to remove only one leading "../" prefix for
 846                                  * the directory we couldn't create in dry-run mode:
 847                                  * this ensures that any other ".." references get
 848                                  * evaluated the same as they would for a live copy. */
 849                                 *slash = '\0';
 850                                 pathjoin(new, len, curr_dir, bdir + 3);
 851                                 *slash = '/';
 852                         } else
 853                                 pathjoin(new, len, curr_dir, bdir);
 854                         basis_dir[j] = bdir = new;
 855                 }
 856                 if (do_stat(bdir, &st) < 0)
 857                         rprintf(FWARNING, "%s arg does not exist: %s\n", alt_dest_opt(0), bdir);
 858                 else if (!S_ISDIR(st.st_mode))
 859                         rprintf(FWARNING, "%s arg is not a dir: %s\n", alt_dest_opt(0), bdir);
 860         }
 861 }
 862
 863 /* This is only called by the sender. */
 864 static void read_final_goodbye(int f_in, int f_out)
 865 {
 866         int i, iflags, xlen;
 867         uchar fnamecmp_type;
 868         char xname[MAXPATHLEN];
 869
 870         shutting_down = True;
 871
 872         if (protocol_version < 29)
 873                 i = read_int(f_in);
 874         else {
 875                 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
 876                 if (protocol_version >= 31 && i == NDX_DONE) {
 877                         if (am_sender)
 878                                 write_ndx(f_out, NDX_DONE);
 879                         else {
 880                                 if (batch_gen_fd >= 0) {
 881                                         while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
 882                                         read_del_stats(batch_gen_fd);
 883                                 }
 884                                 write_int(f_out, NDX_DONE);
 885                         }
 886                         i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
 887                 }
 888         }
 889
 890         if (i != NDX_DONE) {
 891                 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
 892                         i, who_am_i());
 893                 exit_cleanup(RERR_PROTOCOL);
 894         }
 895 }
 896
 897 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
 898 {
 899         struct file_list *flist;
 900         char *dir;
 901
 902         if (DEBUG_GTE(SEND, 1))
 903                 rprintf(FINFO, "server_sender starting pid=%d\n", (int)getpid());
 904
 905         if (am_daemon && lp_write_only(module_id)) {
 906                 rprintf(FERROR, "ERROR: module is write only\n");
 907                 exit_cleanup(RERR_SYNTAX);
 908         }
 909         if (am_daemon && read_only && remove_source_files) {
 910                 rprintf(FERROR,
 911                         "ERROR: --remove-%s-files cannot be used with a read-only module\n",
 912                         remove_source_files == 1 ? "source" : "sent");
 913                 exit_cleanup(RERR_SYNTAX);
 914         }
 915         if (argc < 1) {
 916                 rprintf(FERROR, "ERROR: do_server_sender called without args\n");
 917                 exit_cleanup(RERR_SYNTAX);
 918         }
 919
 920         become_copy_as_user();
 921
 922         dir = argv[0];
 923         if (!relative_paths) {
 924                 if (!change_dir(dir, CD_NORMAL)) {
 925                         rsyserr(FERROR, errno, "change_dir#3 %s failed",
 926                                 full_fname(dir));
 927                         exit_cleanup(RERR_FILESELECT);
 928                 }
 929         }
 930         argc--;
 931         argv++;
 932
 933         if (argc == 0 && (recurse || xfer_dirs || list_only)) {
 934                 argc = 1;
 935                 argv--;
 936                 argv[0] = ".";
 937         }
 938
 939         flist = send_file_list(f_out,argc,argv);
 940         if (!flist || flist->used == 0) {
 941                 /* Make sure input buffering is off so we can't hang in noop_io_until_death(). */
 942                 io_end_buffering_in(0);
 943                 /* TODO:  we should really exit in a more controlled manner. */
 944                 exit_cleanup(0);
 945         }
 946
 947         io_start_buffering_in(f_in);
 948
 949         send_files(f_in, f_out);
 950         io_flush(FULL_FLUSH);
 951         handle_stats(f_out);
 952         if (protocol_version >= 24)
 953                 read_final_goodbye(f_in, f_out);
 954         io_flush(FULL_FLUSH);
 955         exit_cleanup(0);
 956 }
 957
 958
 959 static int do_recv(int f_in, int f_out, char *local_name)
 960 {
 961         int pid;
 962         int exit_code = 0;
 963         int error_pipe[2];
 964
 965         /* The receiving side mustn't obey this, or an existing symlink that
 966          * points to an identical file won't be replaced by the referent. */
 967         copy_links = copy_dirlinks = copy_unsafe_links = 0;
 968
 969 #ifdef SUPPORT_HARD_LINKS
 970         if (preserve_hard_links && !inc_recurse)
 971                 match_hard_links(first_flist);
 972 #endif
 973
 974         if (fd_pair(error_pipe) < 0) {
 975                 rsyserr(FERROR, errno, "pipe failed in do_recv");
 976                 exit_cleanup(RERR_IPC);
 977         }
 978
 979         if (backup_dir) {
 980                 STRUCT_STAT st;
 981                 int ret;
 982                 if (backup_dir_len > 1)
 983                         backup_dir_buf[backup_dir_len-1] = '\0';
 984                 ret = do_stat(backup_dir_buf, &st);
 985                 if (ret != 0 || !S_ISDIR(st.st_mode)) {
 986                         if (ret == 0) {
 987                                 rprintf(FERROR, "The backup-dir is not a directory: %s\n", backup_dir_buf);
 988                                 exit_cleanup(RERR_SYNTAX);
 989                         }
 990                         if (errno != ENOENT) {
 991                                 rprintf(FERROR, "Failed to stat %s: %s\n", backup_dir_buf, strerror(errno));
 992                                 exit_cleanup(RERR_FILEIO);
 993                         }
 994                         if (INFO_GTE(BACKUP, 1))
 995                                 rprintf(FINFO, "(new) backup_dir is %s\n", backup_dir_buf);
 996                 } else if (INFO_GTE(BACKUP, 1))
 997                         rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
 998                 if (backup_dir_len > 1)
 999                         backup_dir_buf[backup_dir_len-1] = '/';
1000         }
1001
1002         if (tmpdir) {
1003                 STRUCT_STAT st;
1004                 int ret = do_stat(tmpdir, &st);
1005                 if (ret < 0 || !S_ISDIR(st.st_mode)) {
1006                         if (ret == 0) {
1007                                 rprintf(FERROR, "The temp-dir is not a directory: %s\n", tmpdir);
1008                                 exit_cleanup(RERR_SYNTAX);
1009                         }
1010                         if (errno == ENOENT) {
1011                                 rprintf(FERROR, "The temp-dir does not exist: %s\n", tmpdir);
1012                                 exit_cleanup(RERR_SYNTAX);
1013                         }
1014                         rprintf(FERROR, "Failed to stat temp-dir %s: %s\n", tmpdir, strerror(errno));
1015                         exit_cleanup(RERR_FILEIO);
1016                 }
1017         }
1018
1019         io_flush(FULL_FLUSH);
1020
1021         if ((pid = do_fork()) == -1) {
1022                 rsyserr(FERROR, errno, "fork failed in do_recv");
1023                 exit_cleanup(RERR_IPC);
1024         }
1025
1026         if (pid == 0) {
1027                 am_receiver = 1;
1028                 send_msgs_to_gen = am_server;
1029
1030                 close(error_pipe[0]);
1031
1032                 /* We can't let two processes write to the socket at one time. */
1033                 io_end_multiplex_out(MPLX_SWITCHING);
1034                 if (f_in != f_out)
1035                         close(f_out);
1036                 sock_f_out = -1;
1037                 f_out = error_pipe[1];
1038
1039                 bwlimit_writemax = 0; /* receiver doesn't need to do this */
1040
1041                 if (read_batch)
1042                         io_start_buffering_in(f_in);
1043                 io_start_multiplex_out(f_out);
1044
1045                 recv_files(f_in, f_out, local_name);
1046                 io_flush(FULL_FLUSH);
1047                 handle_stats(f_in);
1048
1049                 if (output_needs_newline) {
1050                         fputc('\n', stdout);
1051                         output_needs_newline = 0;
1052                 }
1053
1054                 write_int(f_out, NDX_DONE);
1055                 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
1056                 io_flush(FULL_FLUSH);
1057
1058                 /* Handle any keep-alive packets from the post-processing work
1059                  * that the generator does. */
1060                 if (protocol_version >= 29) {
1061                         kluge_around_eof = -1;
1062
1063                         /* This should only get stopped via a USR2 signal. */
1064                         read_final_goodbye(f_in, f_out);
1065
1066                         rprintf(FERROR, "Invalid packet at end of run [%s]\n",
1067                                 who_am_i());
1068                         exit_cleanup(RERR_PROTOCOL);
1069                 }
1070
1071                 /* Finally, we go to sleep until our parent kills us with a
1072                  * USR2 signal.  We sleep for a short time, as on some OSes
1073                  * a signal won't interrupt a sleep! */
1074                 while (1)
1075                         msleep(20);
1076         }
1077
1078         am_generator = 1;
1079         implied_filter_list.head = implied_filter_list.tail = NULL;
1080         flist_receiving_enabled = True;
1081
1082         io_end_multiplex_in(MPLX_SWITCHING);
1083         if (write_batch && !am_server)
1084                 stop_write_batch();
1085
1086         close(error_pipe[1]);
1087         if (f_in != f_out)
1088                 close(f_in);
1089         sock_f_in = -1;
1090         f_in = error_pipe[0];
1091
1092         io_start_buffering_out(f_out);
1093         io_start_multiplex_in(f_in);
1094
1095 #ifdef SUPPORT_HARD_LINKS
1096         if (preserve_hard_links && inc_recurse) {
1097                 struct file_list *flist;
1098                 for (flist = first_flist; flist; flist = flist->next)
1099                         match_hard_links(flist);
1100         }
1101 #endif
1102
1103         generate_files(f_out, local_name);
1104
1105         handle_stats(-1);
1106         io_flush(FULL_FLUSH);
1107         shutting_down = True;
1108         if (protocol_version >= 24) {
1109                 /* send a final goodbye message */
1110                 write_ndx(f_out, NDX_DONE);
1111         }
1112         io_flush(FULL_FLUSH);
1113
1114         kill(pid, SIGUSR2);
1115         wait_process_with_flush(pid, &exit_code);
1116         return exit_code;
1117 }
1118
1119 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
1120 {
1121         int exit_code;
1122         struct file_list *flist;
1123         char *local_name = NULL;
1124         int negated_levels;
1125
1126         if (filesfrom_fd >= 0 && msgs2stderr != 1 && protocol_version < 31) {
1127                 /* We can't mix messages with files-from data on the socket,
1128                  * so temporarily turn off info/debug messages. */
1129                 negate_output_levels();
1130                 negated_levels = 1;
1131         } else
1132                 negated_levels = 0;
1133
1134         if (DEBUG_GTE(RECV, 1))
1135                 rprintf(FINFO, "server_recv(%d) starting pid=%d\n", argc, (int)getpid());
1136
1137         if (am_daemon && read_only) {
1138                 rprintf(FERROR,"ERROR: module is read only\n");
1139                 exit_cleanup(RERR_SYNTAX);
1140                 return;
1141         }
1142
1143         become_copy_as_user();
1144
1145         if (argc > 0) {
1146                 char *dir = argv[0];
1147                 argc--;
1148                 argv++;
1149                 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
1150                         rsyserr(FERROR, errno, "change_dir#4 %s failed",
1151                                 full_fname(dir));
1152                         exit_cleanup(RERR_FILESELECT);
1153                 }
1154         }
1155
1156         if (protocol_version >= 30)
1157                 io_start_multiplex_in(f_in);
1158         else
1159                 io_start_buffering_in(f_in);
1160         recv_filter_list(f_in);
1161
1162         if (filesfrom_fd >= 0) {
1163                 /* We need to send the files-from names to the sender at the
1164                  * same time that we receive the file-list from them, so we
1165                  * need the IO routines to automatically write out the names
1166                  * onto our f_out socket as we read the file-list.  This
1167                  * avoids both deadlock and extra delays/buffers. */
1168                 start_filesfrom_forwarding(filesfrom_fd);
1169                 filesfrom_fd = -1;
1170         }
1171
1172         flist = recv_file_list(f_in, -1);
1173         if (!flist) {
1174                 rprintf(FERROR,"server_recv: recv_file_list error\n");
1175                 exit_cleanup(RERR_FILESELECT);
1176         }
1177         if (inc_recurse && file_total == 1)
1178                 recv_additional_file_list(f_in);
1179
1180         if (negated_levels)
1181                 negate_output_levels();
1182
1183         if (argc > 0)
1184                 local_name = get_local_name(flist,argv[0]);
1185
1186         /* Now that we know what our destination directory turned out to be,
1187          * we can sanitize the --link-/copy-/compare-dest args correctly. */
1188         if (sanitize_paths) {
1189                 char **dir_p;
1190                 for (dir_p = basis_dir; *dir_p; dir_p++)
1191                         *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1192                 if (partial_dir)
1193                         partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1194         }
1195         check_alt_basis_dirs();
1196
1197         if (daemon_filter_list.head) {
1198                 char **dir_p;
1199                 filter_rule_list *elp = &daemon_filter_list;
1200
1201                 for (dir_p = basis_dir; *dir_p; dir_p++) {
1202                         char *dir = *dir_p;
1203                         if (*dir == '/')
1204                                 dir += module_dirlen;
1205                         if (check_filter(elp, FLOG, dir, 1) < 0)
1206                                 goto options_rejected;
1207                 }
1208                 if (partial_dir && *partial_dir == '/'
1209                  && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1210                     options_rejected:
1211                         rprintf(FERROR, "Your options have been rejected by the server.\n");
1212                         exit_cleanup(RERR_SYNTAX);
1213                 }
1214         }
1215
1216         exit_code = do_recv(f_in, f_out, local_name);
1217         exit_cleanup(exit_code);
1218 }
1219
1220
1221 int child_main(int argc, char *argv[])
1222 {
1223         start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1224         return 0;
1225 }
1226
1227
1228 void start_server(int f_in, int f_out, int argc, char *argv[])
1229 {
1230         set_nonblocking(f_in);
1231         set_nonblocking(f_out);
1232
1233         io_set_sock_fds(f_in, f_out);
1234         setup_protocol(f_out, f_in);
1235
1236         if (protocol_version >= 23)
1237                 io_start_multiplex_out(f_out);
1238         if (am_daemon && io_timeout && protocol_version >= 31)
1239                 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1240
1241         if (am_sender) {
1242                 keep_dirlinks = 0; /* Must be disabled on the sender. */
1243                 if (need_messages_from_generator)
1244                         io_start_multiplex_in(f_in);
1245                 else
1246                         io_start_buffering_in(f_in);
1247                 recv_filter_list(f_in);
1248                 do_server_sender(f_in, f_out, argc, argv);
1249         } else
1250                 do_server_recv(f_in, f_out, argc, argv);
1251         exit_cleanup(0);
1252 }
1253
1254 /* This is called once the connection has been negotiated.  It is used
1255  * for rsyncd, remote-shell, and local connections. */
1256 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1257 {
1258         struct file_list *flist = NULL;
1259         int exit_code = 0, exit_code2 = 0;
1260         char *local_name = NULL;
1261
1262         cleanup_child_pid = pid;
1263         if (!read_batch) {
1264                 set_nonblocking(f_in);
1265                 set_nonblocking(f_out);
1266         }
1267
1268         io_set_sock_fds(f_in, f_out);
1269         setup_protocol(f_out,f_in);
1270
1271         /* We set our stderr file handle to blocking because ssh might have
1272          * set it to non-blocking.  This can be particularly troublesome if
1273          * stderr is a clone of stdout, because ssh would have set our stdout
1274          * to non-blocking at the same time (which can easily cause us to lose
1275          * output from our print statements).  This kluge shouldn't cause ssh
1276          * any problems for how we use it.  Note also that we delayed setting
1277          * this until after the above protocol setup so that we know for sure
1278          * that ssh is done twiddling its file descriptors.  */
1279         set_blocking(STDERR_FILENO);
1280
1281         if (am_sender) {
1282                 keep_dirlinks = 0; /* Must be disabled on the sender. */
1283
1284                 if (always_checksum
1285                  && (log_format_has(stdout_format, 'C')
1286                   || log_format_has(logfile_format, 'C')))
1287                         sender_keeps_checksum = 1;
1288
1289                 if (protocol_version >= 30)
1290                         io_start_multiplex_out(f_out);
1291                 else
1292                         io_start_buffering_out(f_out);
1293                 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1294                         io_start_multiplex_in(f_in);
1295                 else
1296                         io_start_buffering_in(f_in);
1297                 send_filter_list(f_out);
1298                 if (filesfrom_host)
1299                         filesfrom_fd = f_in;
1300
1301                 if (write_batch && !am_server)
1302                         start_write_batch(f_out);
1303
1304                 become_copy_as_user();
1305
1306                 flist = send_file_list(f_out, argc, argv);
1307                 if (DEBUG_GTE(FLIST, 3))
1308                         rprintf(FINFO,"file list sent\n");
1309
1310                 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1311                         io_start_multiplex_in(f_in);
1312
1313                 io_flush(NORMAL_FLUSH);
1314                 send_files(f_in, f_out);
1315                 io_flush(FULL_FLUSH);
1316                 handle_stats(-1);
1317                 if (protocol_version >= 24)
1318                         read_final_goodbye(f_in, f_out);
1319                 if (pid != -1) {
1320                         if (DEBUG_GTE(EXIT, 2))
1321                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1322                         io_flush(FULL_FLUSH);
1323                         wait_process_with_flush(pid, &exit_code);
1324                 }
1325                 output_summary();
1326                 io_flush(FULL_FLUSH);
1327                 exit_cleanup(exit_code);
1328         }
1329
1330         if (!read_batch) {
1331                 if (protocol_version >= 23)
1332                         io_start_multiplex_in(f_in);
1333                 if (need_messages_from_generator)
1334                         io_start_multiplex_out(f_out);
1335                 else
1336                         io_start_buffering_out(f_out);
1337         }
1338
1339         become_copy_as_user();
1340
1341         send_filter_list(read_batch ? -1 : f_out);
1342
1343         if (filesfrom_fd >= 0) {
1344                 start_filesfrom_forwarding(filesfrom_fd);
1345                 filesfrom_fd = -1;
1346         }
1347
1348         if (write_batch && !am_server)
1349                 start_write_batch(f_in);
1350         flist = recv_file_list(f_in, -1);
1351         if (inc_recurse && file_total == 1)
1352                 recv_additional_file_list(f_in);
1353
1354         if (flist && flist->used > 0) {
1355                 local_name = get_local_name(flist, argv[0]);
1356
1357                 check_alt_basis_dirs();
1358
1359                 exit_code2 = do_recv(f_in, f_out, local_name);
1360         } else {
1361                 handle_stats(-1);
1362                 output_summary();
1363         }
1364
1365         if (pid != -1) {
1366                 if (DEBUG_GTE(RECV, 1))
1367                         rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1368                 io_flush(FULL_FLUSH);
1369                 wait_process_with_flush(pid, &exit_code);
1370         }
1371
1372         return MAX(exit_code, exit_code2);
1373 }
1374
1375 static void dup_argv(char *argv[])
1376 {
1377         int i;
1378
1379         for (i = 0; argv[i]; i++)
1380                 argv[i] = strdup(argv[i]);
1381 }
1382
1383
1384 /* Start a client for either type of remote connection.  Work out
1385  * whether the arguments request a remote shell or rsyncd connection,
1386  * and call the appropriate connection function, then run_client.
1387  *
1388  * Calls either start_socket_client (for sockets) or do_cmd and
1389  * client_run (for ssh). */
1390 static int start_client(int argc, char *argv[])
1391 {
1392         char *p, *shell_machine = NULL, *shell_user = NULL;
1393         char **remote_argv;
1394         int remote_argc, env_port = rsync_port;
1395         int f_in, f_out;
1396         int ret;
1397         pid_t pid;
1398
1399         /* Don't clobber argv[] so that ps(1) can still show the right
1400          * command line. */
1401         dup_argv(argv);
1402
1403         if (!read_batch) { /* for read_batch, NO source is specified */
1404                 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1405                 if (path) { /* source is remote */
1406                         char *dummy_host;
1407                         int dummy_port = 0;
1408                         *argv = path;
1409                         remote_argv = argv;
1410                         remote_argc = argc;
1411                         argv += argc - 1;
1412                         if (argc == 1 || **argv == ':')
1413                                 argc = 0; /* no dest arg */
1414                         else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1415                                 rprintf(FERROR,
1416                                         "The source and destination cannot both be remote.\n");
1417                                 exit_cleanup(RERR_SYNTAX);
1418                         } else {
1419                                 remote_argc--; /* don't count dest */
1420                                 argc = 1;
1421                         }
1422                         if (filesfrom_host && *filesfrom_host && strcmp(filesfrom_host, shell_machine) != 0) {
1423                                 rprintf(FERROR,
1424                                         "--files-from hostname is not the same as the transfer hostname\n");
1425                                 exit_cleanup(RERR_SYNTAX);
1426                         }
1427                         am_sender = 0;
1428                         if (rsync_port)
1429                                 daemon_connection = shell_cmd ? 1 : -1;
1430                 } else { /* source is local, check dest arg */
1431                         am_sender = 1;
1432
1433                         if (argc > 1) {
1434                                 p = argv[--argc];
1435                                 remote_argv = argv + argc;
1436                         } else {
1437                                 static char *dotarg[1] = { "." };
1438                                 p = dotarg[0];
1439                                 remote_argv = dotarg;
1440                         }
1441                         remote_argc = 1;
1442
1443                         path = check_for_hostspec(p, &shell_machine, &rsync_port);
1444                         if (path && filesfrom_host && *filesfrom_host && strcmp(filesfrom_host, shell_machine) != 0) {
1445                                 rprintf(FERROR,
1446                                         "--files-from hostname is not the same as the transfer hostname\n");
1447                                 exit_cleanup(RERR_SYNTAX);
1448                         }
1449                         if (!path) { /* no hostspec found, so src & dest are local */
1450                                 local_server = 1;
1451                                 if (filesfrom_host) {
1452                                         rprintf(FERROR,
1453                                                 "--files-from cannot be remote when the transfer is local\n");
1454                                         exit_cleanup(RERR_SYNTAX);
1455                                 }
1456                                 shell_machine = NULL;
1457                                 rsync_port = 0;
1458                         } else { /* hostspec was found, so dest is remote */
1459                                 argv[argc] = path;
1460                                 if (rsync_port)
1461                                         daemon_connection = shell_cmd ? 1 : -1;
1462                         }
1463                 }
1464         } else {  /* read_batch */
1465                 local_server = 1;
1466                 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1467                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1468                         exit_cleanup(RERR_SYNTAX);
1469                 }
1470                 remote_argv = argv += argc - 1;
1471                 remote_argc = argc = 1;
1472                 rsync_port = 0;
1473         }
1474
1475         /* A local transfer doesn't unbackslash anything, so leave the args alone. */
1476         if (local_server)
1477                 old_style_args = 2;
1478
1479         if (!rsync_port && remote_argc && !**remote_argv) /* Turn an empty arg into a dot dir. */
1480                 *remote_argv = ".";
1481
1482         if (am_sender) {
1483                 char *dummy_host;
1484                 int dummy_port = rsync_port;
1485                 int i;
1486                 if (!argv[0][0])
1487                         goto invalid_empty;
1488                 /* For local source, extra source args must not have hostspec. */
1489                 for (i = 1; i < argc; i++) {
1490                         if (!argv[i][0]) {
1491                             invalid_empty:
1492                                 rprintf(FERROR, "Empty source arg specified.\n");
1493                                 exit_cleanup(RERR_SYNTAX);
1494                         }
1495                         if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1496                                 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1497                                 exit_cleanup(RERR_SYNTAX);
1498                         }
1499                 }
1500         } else {
1501                 char *dummy_host;
1502                 int dummy_port = rsync_port;
1503                 int i;
1504                 if (filesfrom_fd < 0)
1505                         add_implied_include(remote_argv[0], daemon_connection);
1506                 /* For remote source, any extra source args must have either
1507                  * the same hostname or an empty hostname. */
1508                 for (i = 1; i < remote_argc; i++) {
1509                         char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1510                         if (!arg) {
1511                                 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1512                                 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1513                                 exit_cleanup(RERR_SYNTAX);
1514                         }
1515                         if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1516                                 rprintf(FERROR, "All source args must come from the same machine.\n");
1517                                 exit_cleanup(RERR_SYNTAX);
1518                         }
1519                         if (rsync_port != dummy_port) {
1520                                 if (!rsync_port || !dummy_port)
1521                                         rprintf(FERROR, "All source args must use the same hostspec format.\n");
1522                                 else
1523                                         rprintf(FERROR, "All source args must use the same port number.\n");
1524                                 exit_cleanup(RERR_SYNTAX);
1525                         }
1526                         if (!rsync_port && !*arg) /* Turn an empty arg into a dot dir. */
1527                                 arg = ".";
1528                         remote_argv[i] = arg;
1529                         add_implied_include(arg, daemon_connection);
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 }