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