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-2013 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_receiver;
  28 extern int io_error;
  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;
  35
  36 BOOL shutting_down = False;
  37 BOOL flush_ok_after_signal = False;
  38
  39 #ifdef HAVE_SIGACTION
  40 static struct sigaction sigact;
  41 #endif
  42
  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  **/
  48 void close_all(void)
  49 {
  50 #ifdef SHUTDOWN_ALL_SOCKETS
  51         int max_fd;
  52         int fd;
  53         int ret;
  54         STRUCT_STAT st;
  55
  56         max_fd = sysconf(_SC_OPEN_MAX) - 1;
  57         for (fd = max_fd; fd >= 0; fd--) {
  58                 if ((ret = do_fstat(fd, &st)) == 0) {
  59                         if (is_a_socket(fd))
  60                                 ret = shutdown(fd, 2);
  61                         ret = close(fd);
  62                 }
  63         }
  64 #endif
  65 }
  66
  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  **/
  85 int cleanup_got_literal = 0;
  86
  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 = -1, cleanup_fd_w = -1;
  91 static pid_t cleanup_pid = 0;
  92
  93 pid_t cleanup_child_pid = -1;
  94
  95 /**
  96  * Eventually calls exit(), passing @p code, therefore does not return.
  97  *
  98  * @param code one of the RERR_* codes from errcode.h.
  99  **/
 100 NORETURN void _exit_cleanup(int code, const char *file, int line)
 101 {
 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 first_code = 0;
 106
 107         SIGACTION(SIGUSR1, SIG_IGN);
 108         SIGACTION(SIGUSR2, SIG_IGN);
 109
 110         if (!exit_code) { /* Preserve first error exit info when recursing. */
 111                 exit_code = code;
 112                 exit_file = file;
 113                 exit_line = line < 0 ? -line : line;
 114         }
 115
 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)
 119                 am_server = 2;
 120
 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: */
 125                 switch_step++;
 126
 127                 first_code = code;
 128
 129                 if (output_needs_newline) {
 130                         fputc('\n', stdout);
 131                         output_needs_newline = 0;
 132                 }
 133
 134                 if (DEBUG_GTE(EXIT, 2)) {
 135                         rprintf(FINFO,
 136                                 "[%s] _exit_cleanup(code=%d, file=%s, line=%d): entered\n",
 137                                 who_am_i(), code, file, line);
 138                 }
 139
 140                 /* FALLTHROUGH */
 141 #include "case_N.h"
 142                 switch_step++;
 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 > exit_code)
 150                                         exit_code = status;
 151                         }
 152                 }
 153
 154                 /* FALLTHROUGH */
 155 #include "case_N.h"
 156                 switch_step++;
 157
 158                 if (cleanup_got_literal && (cleanup_fname || cleanup_fd_w != -1)) {
 159                         if (cleanup_fd_r != -1) {
 160                                 close(cleanup_fd_r);
 161                                 cleanup_fd_r = -1;
 162                         }
 163                         if (cleanup_fd_w != -1) {
 164                                 flush_write_file(cleanup_fd_w);
 165                                 close(cleanup_fd_w);
 166                                 cleanup_fd_w = -1;
 167                         }
 168                         if (cleanup_fname && cleanup_new_fname && keep_partial
 169                          && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
 170                                 int tweak_modtime = 0;
 171                                 const char *fname = cleanup_fname;
 172                                 cleanup_fname = NULL;
 173                                 if (!partial_dir) {
 174                                     /* We don't want to leave a partial file with a modern time or it
 175                                      * could be skipped via --update.  Setting the time to something
 176                                      * really old also helps it to stand out as unfinished in an ls. */
 177                                     tweak_modtime = 1;
 178                                     cleanup_file->modtime = 0;
 179                                 }
 180                                 finish_transfer(cleanup_new_fname, fname, NULL, NULL,
 181                                                 cleanup_file, tweak_modtime, !partial_dir);
 182                         }
 183                 }
 184
 185                 /* FALLTHROUGH */
 186 #include "case_N.h"
 187                 switch_step++;
 188
 189                 if (flush_ok_after_signal) {
 190                         flush_ok_after_signal = False;
 191                         if (code == RERR_SIGNAL)
 192                                 io_flush(FULL_FLUSH);
 193                 }
 194                 if (!exit_code && !code)
 195                         io_flush(FULL_FLUSH);
 196
 197                 /* FALLTHROUGH */
 198 #include "case_N.h"
 199                 switch_step++;
 200
 201                 if (cleanup_fname)
 202                         do_unlink(cleanup_fname);
 203                 if (exit_code)
 204                         kill_all(SIGUSR1);
 205                 if (cleanup_pid && cleanup_pid == getpid()) {
 206                         char *pidf = lp_pid_file();
 207                         if (pidf && *pidf)
 208                                 unlink(lp_pid_file());
 209                 }
 210
 211                 if (exit_code == 0) {
 212                         if (code)
 213                                 exit_code = code;
 214                         if (io_error & IOERR_DEL_LIMIT)
 215                                 exit_code = RERR_DEL_LIMIT;
 216                         if (io_error & IOERR_VANISHED)
 217                                 exit_code = RERR_VANISHED;
 218                         if (io_error & IOERR_GENERAL || got_xfer_error)
 219                                 exit_code = RERR_PARTIAL;
 220                 }
 221
 222                 /* If line < 0, this exit is after a MSG_ERROR_EXIT event, so
 223                  * we don't want to output a duplicate error. */
 224                 if ((exit_code && line > 0)
 225                  || am_daemon || (logfile_name && (am_server || !INFO_GTE(STATS, 1))))
 226                         log_exit(exit_code, exit_file, exit_line);
 227
 228                 /* FALLTHROUGH */
 229 #include "case_N.h"
 230                 switch_step++;
 231
 232                 if (DEBUG_GTE(EXIT, 1)) {
 233                         rprintf(FINFO,
 234                                 "[%s] _exit_cleanup(code=%d, file=%s, line=%d): "
 235                                 "about to call exit(%d)\n",
 236                                 who_am_i(), first_code, exit_file, exit_line, exit_code);
 237                 }
 238
 239                 /* FALLTHROUGH */
 240 #include "case_N.h"
 241                 switch_step++;
 242
 243                 if (exit_code && exit_code != RERR_SOCKETIO && exit_code != RERR_STREAMIO && exit_code != RERR_SIGNAL1
 244                  && exit_code != RERR_TIMEOUT && !shutting_down && (protocol_version >= 31 || am_receiver)) {
 245                         if (line > 0) {
 246                                 if (DEBUG_GTE(EXIT, 3)) {
 247                                         rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT with exit_code %d\n",
 248                                                 who_am_i(), exit_code);
 249                                 }
 250                                 send_msg_int(MSG_ERROR_EXIT, exit_code);
 251                         }
 252                         noop_io_until_death();
 253                 }
 254
 255                 /* FALLTHROUGH */
 256 #include "case_N.h"
 257                 switch_step++;
 258
 259                 if (am_server && exit_code)
 260                         msleep(100);
 261                 close_all();
 262
 263                 /* FALLTHROUGH */
 264         default:
 265                 break;
 266         }
 267
 268         exit(exit_code);
 269 }
 270
 271 void cleanup_disable(void)
 272 {
 273         cleanup_fname = cleanup_new_fname = NULL;
 274         cleanup_fd_r = cleanup_fd_w = -1;
 275         cleanup_got_literal = 0;
 276 }
 277
 278
 279 void cleanup_set(const char *fnametmp, const char *fname, struct file_struct *file,
 280                  int fd_r, int fd_w)
 281 {
 282         cleanup_fname = fnametmp;
 283         cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */
 284         cleanup_file = file;
 285         cleanup_fd_r = fd_r;
 286         cleanup_fd_w = fd_w;
 287 }
 288
 289 void cleanup_set_pid(pid_t pid)
 290 {
 291         cleanup_pid = pid;
 292 }