Don't complain about a socket EOF unless it affects a read.
[rsync/rsync.git] / cleanup.c
1 /*
2  * End-of-run cleanup routines.
3  *
4  * Copyright (C) 1996-2000 Andrew Tridgell
5  * Copyright (C) 1996 Paul Mackerras
6  * Copyright (C) 2002 Martin Pool
7  * Copyright (C) 2003-2009 Wayne Davison
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, visit the http://fsf.org website.
21  */
22
23 #include "rsync.h"
24
25 extern int am_server;
26 extern int am_daemon;
27 extern int am_sender;
28 extern int am_generator;
29 extern int io_error;
30 extern int keep_partial;
31 extern int got_xfer_error;
32 extern int protocol_version;
33 extern int output_needs_newline;
34 extern char *partial_dir;
35 extern char *logfile_name;
36
37 #ifdef HAVE_SIGACTION
38 static struct sigaction sigact;
39 #endif
40
41 /**
42  * Close all open sockets and files, allowing a (somewhat) graceful
43  * shutdown() of socket connections.  This eliminates the abortive
44  * TCP RST sent by a Winsock-based system when the close() occurs.
45  **/
46 void close_all(void)
47 {
48 #ifdef SHUTDOWN_ALL_SOCKETS
49         int max_fd;
50         int fd;
51         int ret;
52         STRUCT_STAT st;
53
54         max_fd = sysconf(_SC_OPEN_MAX) - 1;
55         for (fd = max_fd; fd >= 0; fd--) {
56                 if ((ret = do_fstat(fd, &st)) == 0) {
57                         if (is_a_socket(fd))
58                                 ret = shutdown(fd, 2);
59                         ret = close(fd);
60                 }
61         }
62 #endif
63 }
64
65 /**
66  * @file cleanup.c
67  *
68  * Code for handling interrupted transfers.  Depending on the @c
69  * --partial option, we may either delete the temporary file, or go
70  * ahead and overwrite the destination.  This second behaviour only
71  * occurs if we've sent literal data and therefore hopefully made
72  * progress on the transfer.
73  **/
74
75 /**
76  * Set to True once literal data has been sent across the link for the
77  * current file. (????)
78  *
79  * Handling the cleanup when a transfer is interrupted is tricky when
80  * --partial is selected.  We need to ensure that the partial file is
81  * kept if any real data has been transferred.
82  **/
83 int cleanup_got_literal = 0;
84
85 static const char *cleanup_fname;
86 static const char *cleanup_new_fname;
87 static struct file_struct *cleanup_file;
88 static int cleanup_fd_r, cleanup_fd_w;
89 static pid_t cleanup_pid = 0;
90
91 pid_t cleanup_child_pid = -1;
92
93 /**
94  * Eventually calls exit(), passing @p code, therefore does not return.
95  *
96  * @param code one of the RERR_* codes from errcode.h.
97  **/
98 NORETURN void _exit_cleanup(int code, const char *file, int line)
99 {
100         static int cleanup_step = 0;
101         static int exit_code = 0, exit_line = 0;
102         static const char *exit_file = NULL;
103         static int unmodified_code = 0;
104
105         SIGACTION(SIGUSR1, SIG_IGN);
106         SIGACTION(SIGUSR2, SIG_IGN);
107
108         if (exit_code) { /* Preserve first exit info when recursing. */
109                 code = exit_code;
110                 file = exit_file;
111                 line = exit_line;
112         }
113
114         /* If this is the exit at the end of the run, the server side
115          * should not attempt to output a message (see log_exit()). */
116         if (am_server && code == 0)
117                 am_server = 2;
118
119         /* Some of our actions might cause a recursive call back here, so we
120          * keep track of where we are in the cleanup and never repeat a step. */
121         switch (cleanup_step) {
122 #include "case_N.h" /* case 0: cleanup_step++; */
123
124                 exit_code = unmodified_code = code;
125                 exit_file = file;
126                 exit_line = line;
127
128                 if (output_needs_newline) {
129                         fputc('\n', stdout);
130                         output_needs_newline = 0;
131                 }
132
133                 if (DEBUG_GTE(EXIT, 2)) {
134                         rprintf(FINFO,
135                                 "_exit_cleanup(code=%d, file=%s, line=%d): entered\n",
136                                 code, file, line);
137                 }
138
139                 /* FALLTHROUGH */
140 #include "case_N.h"
141
142                 if (cleanup_child_pid != -1) {
143                         int status;
144                         int pid = wait_process(cleanup_child_pid, &status, WNOHANG);
145                         if (pid == cleanup_child_pid) {
146                                 status = WEXITSTATUS(status);
147                                 if (status > code)
148                                         code = exit_code = status;
149                         }
150                 }
151
152                 /* FALLTHROUGH */
153 #include "case_N.h"
154
155                 if (cleanup_got_literal && cleanup_fname && cleanup_new_fname
156                  && keep_partial && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
157                         const char *fname = cleanup_fname;
158                         cleanup_fname = NULL;
159                         if (cleanup_fd_r != -1)
160                                 close(cleanup_fd_r);
161                         if (cleanup_fd_w != -1) {
162                                 flush_write_file(cleanup_fd_w);
163                                 close(cleanup_fd_w);
164                         }
165                         finish_transfer(cleanup_new_fname, fname, NULL, NULL,
166                                         cleanup_file, 0, !partial_dir);
167                 }
168
169                 /* FALLTHROUGH */
170 #include "case_N.h"
171
172                 if (!code || am_server || (!am_sender && !am_generator))
173                         io_flush(FULL_FLUSH);
174
175                 /* FALLTHROUGH */
176 #include "case_N.h"
177
178                 if (cleanup_fname)
179                         do_unlink(cleanup_fname);
180                 if (code)
181                         kill_all(SIGUSR1);
182                 if (cleanup_pid && cleanup_pid == getpid()) {
183                         char *pidf = lp_pid_file();
184                         if (pidf && *pidf)
185                                 unlink(lp_pid_file());
186                 }
187
188                 if (code == 0) {
189                         if (io_error & IOERR_DEL_LIMIT)
190                                 code = exit_code = RERR_DEL_LIMIT;
191                         if (io_error & IOERR_VANISHED)
192                                 code = exit_code = RERR_VANISHED;
193                         if (io_error & IOERR_GENERAL || got_xfer_error)
194                                 code = exit_code = RERR_PARTIAL;
195                 }
196
197                 /* If line < 0, this exit is after a MSG_ERROR_EXIT event, so
198                  * we don't want to output a duplicate error. */
199                 if ((code && line > 0)
200                  || am_daemon || (logfile_name && (am_server || !INFO_GTE(STATS, 1))))
201                         log_exit(code, file, line);
202
203                 /* FALLTHROUGH */
204 #include "case_N.h"
205
206                 if (DEBUG_GTE(EXIT, 1)) {
207                         rprintf(FINFO,
208                                 "_exit_cleanup(code=%d, file=%s, line=%d): "
209                                 "about to call exit(%d)\n",
210                                 unmodified_code, file, line, code);
211                 }
212
213                 /* FALLTHROUGH */
214 #include "case_N.h"
215
216                 if (exit_code && exit_code != RERR_STREAMIO && exit_code != RERR_SIGNAL1
217                  && (protocol_version >= 31 || (!am_sender && !am_generator))) {
218                         if (line > 0)
219                                 send_msg_int(MSG_ERROR_EXIT, exit_code);
220                         noop_io_until_death();
221                 }
222
223                 /* FALLTHROUGH */
224 #include "case_N.h"
225
226                 if (am_server && code)
227                         msleep(100);
228                 close_all();
229
230                 /* FALLTHROUGH */
231         default:
232                 break;
233         }
234
235         exit(code);
236 }
237
238 void cleanup_disable(void)
239 {
240         cleanup_fname = cleanup_new_fname = NULL;
241         cleanup_got_literal = 0;
242 }
243
244
245 void cleanup_set(const char *fnametmp, const char *fname, struct file_struct *file,
246                  int fd_r, int fd_w)
247 {
248         cleanup_fname = fnametmp;
249         cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */
250         cleanup_file = file;
251         cleanup_fd_r = fd_r;
252         cleanup_fd_w = fd_w;
253 }
254
255 void cleanup_set_pid(pid_t pid)
256 {
257         cleanup_pid = pid;
258 }