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