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