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