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