| 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, 2004, 2005, 2006 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 2 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, write to the Free Software Foundation, Inc., |
| 21 | * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. |
| 22 | */ |
| 23 | |
| 24 | #include "rsync.h" |
| 25 | |
| 26 | extern int am_server; |
| 27 | extern int am_daemon; |
| 28 | extern int io_error; |
| 29 | extern int keep_partial; |
| 30 | extern int log_got_error; |
| 31 | extern char *partial_dir; |
| 32 | extern char *logfile_name; |
| 33 | |
| 34 | #ifdef HAVE_SIGACTION |
| 35 | static struct sigaction sigact; |
| 36 | #endif |
| 37 | |
| 38 | /** |
| 39 | * Close all open sockets and files, allowing a (somewhat) graceful |
| 40 | * shutdown() of socket connections. This eliminates the abortive |
| 41 | * TCP RST sent by a Winsock-based system when the close() occurs. |
| 42 | **/ |
| 43 | void close_all(void) |
| 44 | { |
| 45 | #ifdef SHUTDOWN_ALL_SOCKETS |
| 46 | int max_fd; |
| 47 | int fd; |
| 48 | int ret; |
| 49 | STRUCT_STAT st; |
| 50 | |
| 51 | max_fd = sysconf(_SC_OPEN_MAX) - 1; |
| 52 | for (fd = max_fd; fd >= 0; fd--) { |
| 53 | if ((ret = do_fstat(fd, &st)) == 0) { |
| 54 | if (is_a_socket(fd)) |
| 55 | ret = shutdown(fd, 2); |
| 56 | ret = close(fd); |
| 57 | } |
| 58 | } |
| 59 | #endif |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * @file cleanup.c |
| 64 | * |
| 65 | * Code for handling interrupted transfers. Depending on the @c |
| 66 | * --partial option, we may either delete the temporary file, or go |
| 67 | * ahead and overwrite the destination. This second behaviour only |
| 68 | * occurs if we've sent literal data and therefore hopefully made |
| 69 | * progress on the transfer. |
| 70 | **/ |
| 71 | |
| 72 | /** |
| 73 | * Set to True once literal data has been sent across the link for the |
| 74 | * current file. (????) |
| 75 | * |
| 76 | * Handling the cleanup when a transfer is interrupted is tricky when |
| 77 | * --partial is selected. We need to ensure that the partial file is |
| 78 | * kept if any real data has been transferred. |
| 79 | **/ |
| 80 | int cleanup_got_literal = 0; |
| 81 | |
| 82 | static char *cleanup_fname; |
| 83 | static char *cleanup_new_fname; |
| 84 | static struct file_struct *cleanup_file; |
| 85 | static int cleanup_fd_r, cleanup_fd_w; |
| 86 | static pid_t cleanup_pid = 0; |
| 87 | |
| 88 | pid_t cleanup_child_pid = -1; |
| 89 | |
| 90 | /** |
| 91 | * Eventually calls exit(), passing @p code, therefore does not return. |
| 92 | * |
| 93 | * @param code one of the RERR_* codes from errcode.h. |
| 94 | **/ |
| 95 | NORETURN void _exit_cleanup(int code, const char *file, int line) |
| 96 | { |
| 97 | static int cleanup_step = 0; |
| 98 | static int exit_code = 0; |
| 99 | static int unmodified_code = 0; |
| 100 | |
| 101 | SIGACTION(SIGUSR1, SIG_IGN); |
| 102 | SIGACTION(SIGUSR2, SIG_IGN); |
| 103 | |
| 104 | if (exit_code) /* Preserve first error code when recursing. */ |
| 105 | code = exit_code; |
| 106 | |
| 107 | /* Some of our actions might cause a recursive call back here, so we |
| 108 | * keep track of where we are in the cleanup and never repeat a step. */ |
| 109 | switch (cleanup_step) { |
| 110 | #include "case_N.h" /* case 0: cleanup_step++; */ |
| 111 | |
| 112 | exit_code = unmodified_code = code; |
| 113 | |
| 114 | if (verbose > 3) { |
| 115 | rprintf(FINFO, |
| 116 | "_exit_cleanup(code=%d, file=%s, line=%d): entered\n", |
| 117 | code, file, line); |
| 118 | } |
| 119 | |
| 120 | /* FALLTHROUGH */ |
| 121 | #include "case_N.h" |
| 122 | |
| 123 | if (cleanup_child_pid != -1) { |
| 124 | int status; |
| 125 | int pid = wait_process(cleanup_child_pid, &status, WNOHANG); |
| 126 | if (pid == cleanup_child_pid) { |
| 127 | status = WEXITSTATUS(status); |
| 128 | if (status > code) |
| 129 | code = exit_code = status; |
| 130 | } |
| 131 | } |
| 132 | |
| 133 | /* FALLTHROUGH */ |
| 134 | #include "case_N.h" |
| 135 | |
| 136 | if (cleanup_got_literal && cleanup_fname && cleanup_new_fname |
| 137 | && keep_partial && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) { |
| 138 | char *fname = cleanup_fname; |
| 139 | cleanup_fname = NULL; |
| 140 | if (cleanup_fd_r != -1) |
| 141 | close(cleanup_fd_r); |
| 142 | if (cleanup_fd_w != -1) { |
| 143 | flush_write_file(cleanup_fd_w); |
| 144 | close(cleanup_fd_w); |
| 145 | } |
| 146 | finish_transfer(cleanup_new_fname, fname, NULL, |
| 147 | cleanup_file, 0, !partial_dir); |
| 148 | } |
| 149 | |
| 150 | /* FALLTHROUGH */ |
| 151 | #include "case_N.h" |
| 152 | |
| 153 | io_flush(FULL_FLUSH); |
| 154 | |
| 155 | /* FALLTHROUGH */ |
| 156 | #include "case_N.h" |
| 157 | |
| 158 | if (cleanup_fname) |
| 159 | do_unlink(cleanup_fname); |
| 160 | if (code) |
| 161 | kill_all(SIGUSR1); |
| 162 | if (cleanup_pid && cleanup_pid == getpid()) { |
| 163 | char *pidf = lp_pid_file(); |
| 164 | if (pidf && *pidf) |
| 165 | unlink(lp_pid_file()); |
| 166 | } |
| 167 | |
| 168 | if (code == 0) { |
| 169 | if (io_error & IOERR_DEL_LIMIT) |
| 170 | code = exit_code = RERR_DEL_LIMIT; |
| 171 | if (io_error & IOERR_VANISHED) |
| 172 | code = exit_code = RERR_VANISHED; |
| 173 | if (io_error & IOERR_GENERAL || log_got_error) |
| 174 | code = exit_code = RERR_PARTIAL; |
| 175 | } |
| 176 | |
| 177 | if (code || am_daemon || (logfile_name && (am_server || !verbose))) |
| 178 | log_exit(code, file, line); |
| 179 | |
| 180 | /* FALLTHROUGH */ |
| 181 | #include "case_N.h" |
| 182 | |
| 183 | if (verbose > 2) { |
| 184 | rprintf(FINFO, |
| 185 | "_exit_cleanup(code=%d, file=%s, line=%d): " |
| 186 | "about to call exit(%d)\n", |
| 187 | unmodified_code, file, line, code); |
| 188 | } |
| 189 | |
| 190 | /* FALLTHROUGH */ |
| 191 | #include "case_N.h" |
| 192 | |
| 193 | close_all(); |
| 194 | |
| 195 | /* FALLTHROUGH */ |
| 196 | default: |
| 197 | break; |
| 198 | } |
| 199 | |
| 200 | exit(code); |
| 201 | } |
| 202 | |
| 203 | void cleanup_disable(void) |
| 204 | { |
| 205 | cleanup_fname = cleanup_new_fname = NULL; |
| 206 | cleanup_got_literal = 0; |
| 207 | } |
| 208 | |
| 209 | |
| 210 | void cleanup_set(char *fnametmp, char *fname, struct file_struct *file, |
| 211 | int fd_r, int fd_w) |
| 212 | { |
| 213 | cleanup_fname = fnametmp; |
| 214 | cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */ |
| 215 | cleanup_file = file; |
| 216 | cleanup_fd_r = fd_r; |
| 217 | cleanup_fd_w = fd_w; |
| 218 | } |
| 219 | |
| 220 | void cleanup_set_pid(pid_t pid) |
| 221 | { |
| 222 | cleanup_pid = pid; |
| 223 | } |