2 * End-of-run cleanup routines.
4 * Copyright (C) 1996-2000 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2002 Martin Pool
7 * Copyright (C) 2003-2013 Wayne Davison
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.
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.
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.
27 extern int am_receiver;
29 extern int keep_partial;
30 extern int got_xfer_error;
31 extern int protocol_version;
32 extern int output_needs_newline;
33 extern char *partial_dir;
34 extern char *logfile_name;
36 BOOL shutting_down = False;
37 BOOL flush_ok_after_signal = False;
40 static struct sigaction sigact;
44 * Close all open sockets and files, allowing a (somewhat) graceful
45 * shutdown() of socket connections. This eliminates the abortive
46 * TCP RST sent by a Winsock-based system when the close() occurs.
50 #ifdef SHUTDOWN_ALL_SOCKETS
56 max_fd = sysconf(_SC_OPEN_MAX) - 1;
57 for (fd = max_fd; fd >= 0; fd--) {
58 if ((ret = do_fstat(fd, &st)) == 0) {
60 ret = shutdown(fd, 2);
70 * Code for handling interrupted transfers. Depending on the @c
71 * --partial option, we may either delete the temporary file, or go
72 * ahead and overwrite the destination. This second behaviour only
73 * occurs if we've sent literal data and therefore hopefully made
74 * progress on the transfer.
78 * Set to True once literal data has been sent across the link for the
79 * current file. (????)
81 * Handling the cleanup when a transfer is interrupted is tricky when
82 * --partial is selected. We need to ensure that the partial file is
83 * kept if any real data has been transferred.
85 int cleanup_got_literal = 0;
87 static const char *cleanup_fname;
88 static const char *cleanup_new_fname;
89 static struct file_struct *cleanup_file;
90 static int cleanup_fd_r, cleanup_fd_w;
91 static pid_t cleanup_pid = 0;
93 pid_t cleanup_child_pid = -1;
96 * Eventually calls exit(), passing @p code, therefore does not return.
98 * @param code one of the RERR_* codes from errcode.h.
100 NORETURN void _exit_cleanup(int code, const char *file, int line)
102 static int switch_step = 0;
103 static int exit_code = 0, exit_line = 0;
104 static const char *exit_file = NULL;
105 static int unmodified_code = 0;
107 SIGACTION(SIGUSR1, SIG_IGN);
108 SIGACTION(SIGUSR2, SIG_IGN);
110 if (exit_code) { /* Preserve first exit info when recursing. */
116 /* If this is the exit at the end of the run, the server side
117 * should not attempt to output a message (see log_exit()). */
118 if (am_server && code == 0)
121 /* Some of our actions might cause a recursive call back here, so we
122 * keep track of where we are in the cleanup and never repeat a step. */
123 switch (switch_step) {
124 #include "case_N.h" /* case 0: */
127 exit_code = unmodified_code = code;
131 if (output_needs_newline) {
133 output_needs_newline = 0;
136 if (DEBUG_GTE(EXIT, 2)) {
138 "[%s] _exit_cleanup(code=%d, file=%s, line=%d): entered\n",
139 who_am_i(), code, file, line);
146 if (cleanup_child_pid != -1) {
148 int pid = wait_process(cleanup_child_pid, &status, WNOHANG);
149 if (pid == cleanup_child_pid) {
150 status = WEXITSTATUS(status);
152 code = exit_code = status;
160 if (cleanup_got_literal && cleanup_fname && cleanup_new_fname
161 && keep_partial && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
162 int tweak_modtime = 0;
163 const char *fname = cleanup_fname;
164 cleanup_fname = NULL;
165 if (cleanup_fd_r != -1)
167 if (cleanup_fd_w != -1) {
168 flush_write_file(cleanup_fd_w);
172 /* We don't want to leave a partial file with a modern time or it
173 * could be skipped via --update. Setting the time to something
174 * really old also helps it to stand out as unfinished in an ls. */
176 cleanup_file->modtime = 0;
178 finish_transfer(cleanup_new_fname, fname, NULL, NULL,
179 cleanup_file, tweak_modtime, !partial_dir);
186 if (flush_ok_after_signal) {
187 flush_ok_after_signal = False;
188 if (code == RERR_SIGNAL)
189 io_flush(FULL_FLUSH);
192 io_flush(FULL_FLUSH);
199 do_unlink(cleanup_fname);
202 if (cleanup_pid && cleanup_pid == getpid()) {
203 char *pidf = lp_pid_file();
205 unlink(lp_pid_file());
209 if (io_error & IOERR_DEL_LIMIT)
210 code = exit_code = RERR_DEL_LIMIT;
211 if (io_error & IOERR_VANISHED)
212 code = exit_code = RERR_VANISHED;
213 if (io_error & IOERR_GENERAL || got_xfer_error)
214 code = exit_code = RERR_PARTIAL;
217 /* If line < 0, this exit is after a MSG_ERROR_EXIT event, so
218 * we don't want to output a duplicate error. */
219 if ((code && line > 0)
220 || am_daemon || (logfile_name && (am_server || !INFO_GTE(STATS, 1))))
221 log_exit(code, file, line);
227 if (DEBUG_GTE(EXIT, 1)) {
229 "[%s] _exit_cleanup(code=%d, file=%s, line=%d): "
230 "about to call exit(%d)\n",
231 who_am_i(), unmodified_code, file, line, code);
238 if (exit_code && exit_code != RERR_SOCKETIO && exit_code != RERR_STREAMIO && exit_code != RERR_SIGNAL1
239 && exit_code != RERR_TIMEOUT && !shutting_down && (protocol_version >= 31 || am_receiver)) {
241 if (DEBUG_GTE(EXIT, 3)) {
242 rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT with exit_code %d\n",
243 who_am_i(), exit_code);
245 send_msg_int(MSG_ERROR_EXIT, exit_code);
247 noop_io_until_death();
254 if (am_server && code)
266 void cleanup_disable(void)
268 cleanup_fname = cleanup_new_fname = NULL;
269 cleanup_got_literal = 0;
273 void cleanup_set(const char *fnametmp, const char *fname, struct file_struct *file,
276 cleanup_fname = fnametmp;
277 cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */
283 void cleanup_set_pid(pid_t pid)