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; | |
f9185203 WD |
27 | extern int am_sender; |
28 | extern int am_generator; | |
6e86c951 WD |
29 | extern int io_error; |
30 | extern int keep_partial; | |
3f0211b6 | 31 | extern int got_xfer_error; |
f9185203 | 32 | extern int protocol_version; |
951e826b | 33 | extern int output_needs_newline; |
d45898df | 34 | extern char *partial_dir; |
1cfcb8af | 35 | extern char *logfile_name; |
6e86c951 | 36 | |
0c2e8f93 WD |
37 | BOOL shutting_down = False; |
38 | ||
44e604f4 | 39 | #ifdef HAVE_SIGACTION |
2b28968d WD |
40 | static struct sigaction sigact; |
41 | #endif | |
42 | ||
9f639210 DD |
43 | /** |
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. | |
47 | **/ | |
18d6b679 | 48 | void close_all(void) |
9f639210 DD |
49 | { |
50 | #ifdef SHUTDOWN_ALL_SOCKETS | |
51 | int max_fd; | |
52 | int fd; | |
53 | int ret; | |
58fef0ac | 54 | STRUCT_STAT st; |
9f639210 DD |
55 | |
56 | max_fd = sysconf(_SC_OPEN_MAX) - 1; | |
57 | for (fd = max_fd; fd >= 0; fd--) { | |
58fef0ac | 58 | if ((ret = do_fstat(fd, &st)) == 0) { |
8186ae6b | 59 | if (is_a_socket(fd)) |
9f639210 | 60 | ret = shutdown(fd, 2); |
9f639210 DD |
61 | ret = close(fd); |
62 | } | |
63 | } | |
64 | #endif | |
65 | } | |
66 | ||
e0fde757 MP |
67 | /** |
68 | * @file cleanup.c | |
69 | * | |
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. | |
75 | **/ | |
76 | ||
77 | /** | |
78 | * Set to True once literal data has been sent across the link for the | |
79 | * current file. (????) | |
80 | * | |
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. | |
84 | **/ | |
8186ae6b | 85 | int cleanup_got_literal = 0; |
2f03f956 | 86 | |
93204cca WD |
87 | static const char *cleanup_fname; |
88 | static const char *cleanup_new_fname; | |
2f03f956 | 89 | static struct file_struct *cleanup_file; |
b6609caf | 90 | static int cleanup_fd_r, cleanup_fd_w; |
65fc84b3 | 91 | static pid_t cleanup_pid = 0; |
2f03f956 | 92 | |
19b27a48 | 93 | pid_t cleanup_child_pid = -1; |
ef1aa910 | 94 | |
e0fde757 | 95 | /** |
b0f451eb | 96 | * Eventually calls exit(), passing @p code, therefore does not return. |
e0fde757 MP |
97 | * |
98 | * @param code one of the RERR_* codes from errcode.h. | |
99 | **/ | |
b1b54199 | 100 | NORETURN void _exit_cleanup(int code, const char *file, int line) |
2f03f956 | 101 | { |
154c345d | 102 | static int cleanup_step = 0; |
9270e88d WD |
103 | static int exit_code = 0, exit_line = 0; |
104 | static const char *exit_file = NULL; | |
154c345d | 105 | static int unmodified_code = 0; |
2f03f956 | 106 | |
2b28968d WD |
107 | SIGACTION(SIGUSR1, SIG_IGN); |
108 | SIGACTION(SIGUSR2, SIG_IGN); | |
2f03f956 | 109 | |
9270e88d | 110 | if (exit_code) { /* Preserve first exit info when recursing. */ |
154c345d | 111 | code = exit_code; |
9270e88d WD |
112 | file = exit_file; |
113 | line = exit_line; | |
114 | } | |
b1b54199 | 115 | |
969cdffb | 116 | /* If this is the exit at the end of the run, the server side |
37077bd3 | 117 | * should not attempt to output a message (see log_exit()). */ |
969cdffb WD |
118 | if (am_server && code == 0) |
119 | am_server = 2; | |
120 | ||
154c345d WD |
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 (cleanup_step) { | |
e3794138 | 124 | #include "case_N.h" /* case 0: cleanup_step++; */ |
154c345d WD |
125 | |
126 | exit_code = unmodified_code = code; | |
9270e88d WD |
127 | exit_file = file; |
128 | exit_line = line; | |
9098bbf3 | 129 | |
951e826b | 130 | if (output_needs_newline) { |
bb4e4d88 | 131 | fputc('\n', stdout); |
951e826b | 132 | output_needs_newline = 0; |
bb4e4d88 WD |
133 | } |
134 | ||
951e826b | 135 | if (DEBUG_GTE(EXIT, 2)) { |
154c345d | 136 | rprintf(FINFO, |
0c2e8f93 WD |
137 | "[%s] _exit_cleanup(code=%d, file=%s, line=%d): entered\n", |
138 | who_am_i(), code, file, line); | |
19b27a48 | 139 | } |
19b27a48 | 140 | |
154c345d | 141 | /* FALLTHROUGH */ |
e3794138 | 142 | #include "case_N.h" |
154c345d WD |
143 | |
144 | if (cleanup_child_pid != -1) { | |
145 | int status; | |
146 | int pid = wait_process(cleanup_child_pid, &status, WNOHANG); | |
147 | if (pid == cleanup_child_pid) { | |
148 | status = WEXITSTATUS(status); | |
149 | if (status > code) | |
150 | code = exit_code = status; | |
151 | } | |
09e2bbce | 152 | } |
9b73d1c0 | 153 | |
154c345d | 154 | /* FALLTHROUGH */ |
e3794138 | 155 | #include "case_N.h" |
154c345d WD |
156 | |
157 | if (cleanup_got_literal && cleanup_fname && cleanup_new_fname | |
158 | && keep_partial && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) { | |
93204cca | 159 | const char *fname = cleanup_fname; |
154c345d WD |
160 | cleanup_fname = NULL; |
161 | if (cleanup_fd_r != -1) | |
162 | close(cleanup_fd_r); | |
163 | if (cleanup_fd_w != -1) { | |
164 | flush_write_file(cleanup_fd_w); | |
165 | close(cleanup_fd_w); | |
166 | } | |
16edf865 | 167 | finish_transfer(cleanup_new_fname, fname, NULL, NULL, |
154c345d WD |
168 | cleanup_file, 0, !partial_dir); |
169 | } | |
170 | ||
171 | /* FALLTHROUGH */ | |
e3794138 | 172 | #include "case_N.h" |
154c345d | 173 | |
f9185203 WD |
174 | if (!code || am_server || (!am_sender && !am_generator)) |
175 | io_flush(FULL_FLUSH); | |
154c345d WD |
176 | |
177 | /* FALLTHROUGH */ | |
e3794138 | 178 | #include "case_N.h" |
154c345d WD |
179 | |
180 | if (cleanup_fname) | |
181 | do_unlink(cleanup_fname); | |
182 | if (code) | |
183 | kill_all(SIGUSR1); | |
184 | if (cleanup_pid && cleanup_pid == getpid()) { | |
185 | char *pidf = lp_pid_file(); | |
186 | if (pidf && *pidf) | |
187 | unlink(lp_pid_file()); | |
188 | } | |
189 | ||
190 | if (code == 0) { | |
191 | if (io_error & IOERR_DEL_LIMIT) | |
192 | code = exit_code = RERR_DEL_LIMIT; | |
193 | if (io_error & IOERR_VANISHED) | |
194 | code = exit_code = RERR_VANISHED; | |
3f0211b6 | 195 | if (io_error & IOERR_GENERAL || got_xfer_error) |
154c345d WD |
196 | code = exit_code = RERR_PARTIAL; |
197 | } | |
198 | ||
304d7b58 WD |
199 | /* If line < 0, this exit is after a MSG_ERROR_EXIT event, so |
200 | * we don't want to output a duplicate error. */ | |
201 | if ((code && line > 0) | |
f9185203 | 202 | || am_daemon || (logfile_name && (am_server || !INFO_GTE(STATS, 1)))) |
154c345d WD |
203 | log_exit(code, file, line); |
204 | ||
205 | /* FALLTHROUGH */ | |
e3794138 | 206 | #include "case_N.h" |
154c345d | 207 | |
951e826b | 208 | if (DEBUG_GTE(EXIT, 1)) { |
154c345d | 209 | rprintf(FINFO, |
0c2e8f93 | 210 | "[%s] _exit_cleanup(code=%d, file=%s, line=%d): " |
154c345d | 211 | "about to call exit(%d)\n", |
0c2e8f93 | 212 | who_am_i(), unmodified_code, file, line, code); |
154c345d WD |
213 | } |
214 | ||
304d7b58 WD |
215 | /* FALLTHROUGH */ |
216 | #include "case_N.h" | |
217 | ||
e4c598c8 | 218 | if (exit_code && exit_code != RERR_SOCKETIO && exit_code != RERR_STREAMIO && exit_code != RERR_SIGNAL1 |
0c2e8f93 WD |
219 | && !shutting_down && (protocol_version >= 31 || (!am_sender && !am_generator))) { |
220 | if (line > 0) { | |
221 | if (DEBUG_GTE(EXIT, 3)) { | |
222 | rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT with exit_code %d\n", | |
223 | who_am_i(), exit_code); | |
224 | } | |
304d7b58 | 225 | send_msg_int(MSG_ERROR_EXIT, exit_code); |
0c2e8f93 | 226 | } |
304d7b58 WD |
227 | noop_io_until_death(); |
228 | } | |
229 | ||
154c345d | 230 | /* FALLTHROUGH */ |
e3794138 | 231 | #include "case_N.h" |
ff81e809 | 232 | |
377d22ab WD |
233 | if (am_server && code) |
234 | msleep(100); | |
154c345d | 235 | close_all(); |
19b27a48 | 236 | |
154c345d WD |
237 | /* FALLTHROUGH */ |
238 | default: | |
239 | break; | |
6e86c951 | 240 | } |
9098bbf3 | 241 | |
2f03f956 AT |
242 | exit(code); |
243 | } | |
244 | ||
245 | void cleanup_disable(void) | |
246 | { | |
03dbc0b8 | 247 | cleanup_fname = cleanup_new_fname = NULL; |
2f03f956 AT |
248 | cleanup_got_literal = 0; |
249 | } | |
250 | ||
251 | ||
93204cca | 252 | void cleanup_set(const char *fnametmp, const char *fname, struct file_struct *file, |
b6609caf | 253 | int fd_r, int fd_w) |
2f03f956 | 254 | { |
03dbc0b8 WD |
255 | cleanup_fname = fnametmp; |
256 | cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */ | |
2f03f956 | 257 | cleanup_file = file; |
b6609caf WD |
258 | cleanup_fd_r = fd_r; |
259 | cleanup_fd_w = fd_w; | |
2f03f956 | 260 | } |
8638dd48 | 261 | |
65fc84b3 | 262 | void cleanup_set_pid(pid_t pid) |
8638dd48 DD |
263 | { |
264 | cleanup_pid = pid; | |
265 | } |