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