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