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