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