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