cleanup.c

   1 /* -*- c-file-style: "linux" -*-
   2
   3    Copyright (C) 1996-2000 by Andrew Tridgell
   4    Copyright (C) Paul Mackerras 1996
   5    Copyright (C) 2002 by Martin Pool
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include "rsync.h"
  23
  24 extern int io_error;
  25 extern int keep_partial;
  26 extern int log_got_error;
  27 extern char *partial_dir;
  28
  29 #ifdef HAVE_SIGACTION
  30 static struct sigaction sigact;
  31 #endif
  32
  33 /**
  34  * Close all open sockets and files, allowing a (somewhat) graceful
  35  * shutdown() of socket connections.  This eliminates the abortive
  36  * TCP RST sent by a Winsock-based system when the close() occurs.
  37  **/
  38 void close_all(void)
  39 {
  40 #ifdef SHUTDOWN_ALL_SOCKETS
  41         int max_fd;
  42         int fd;
  43         int ret;
  44         STRUCT_STAT st;
  45
  46         max_fd = sysconf(_SC_OPEN_MAX) - 1;
  47         for (fd = max_fd; fd >= 0; fd--) {
  48                 if ((ret = do_fstat(fd, &st)) == 0) {
  49                         if (is_a_socket(fd))
  50                                 ret = shutdown(fd, 2);
  51                         ret = close(fd);
  52                 }
  53         }
  54 #endif
  55 }
  56
  57 /**
  58  * @file cleanup.c
  59  *
  60  * Code for handling interrupted transfers.  Depending on the @c
  61  * --partial option, we may either delete the temporary file, or go
  62  * ahead and overwrite the destination.  This second behaviour only
  63  * occurs if we've sent literal data and therefore hopefully made
  64  * progress on the transfer.
  65  **/
  66
  67 /**
  68  * Set to True once literal data has been sent across the link for the
  69  * current file. (????)
  70  *
  71  * Handling the cleanup when a transfer is interrupted is tricky when
  72  * --partial is selected.  We need to ensure that the partial file is
  73  * kept if any real data has been transferred.
  74  **/
  75 int cleanup_got_literal = 0;
  76
  77 static char *cleanup_fname;
  78 static char *cleanup_new_fname;
  79 static struct file_struct *cleanup_file;
  80 static int cleanup_fd_r, cleanup_fd_w;
  81 static pid_t cleanup_pid = 0;
  82
  83 pid_t cleanup_child_pid = -1;
  84
  85 /**
  86  * Eventually calls exit(), passing @p code, therefore does not return.
  87  *
  88  * @param code one of the RERR_* codes from errcode.h.
  89  **/
  90 void _exit_cleanup(int code, const char *file, int line)
  91 {
  92         int ocode = code;
  93         static int inside_cleanup = 0;
  94
  95         if (inside_cleanup > 10) {
  96                 /* prevent the occasional infinite recursion */
  97                 return;
  98         }
  99         inside_cleanup++;
 100
 101         SIGACTION(SIGUSR1, SIG_IGN);
 102         SIGACTION(SIGUSR2, SIG_IGN);
 103
 104         if (verbose > 3) {
 105                 rprintf(FINFO,"_exit_cleanup(code=%d, file=%s, line=%d): entered\n",
 106                         code, file, line);
 107         }
 108
 109         if (cleanup_child_pid != -1) {
 110                 int status;
 111                 if (wait_process(cleanup_child_pid, &status, WNOHANG)
 112                  == cleanup_child_pid) {
 113                         status = WEXITSTATUS(status);
 114                         if (status > code)
 115                                 code = status;
 116                 }
 117         }
 118
 119         if (cleanup_got_literal && cleanup_fname && keep_partial
 120             && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
 121                 char *fname = cleanup_fname;
 122                 cleanup_fname = NULL;
 123                 if (cleanup_fd_r != -1)
 124                         close(cleanup_fd_r);
 125                 if (cleanup_fd_w != -1) {
 126                         flush_write_file(cleanup_fd_w);
 127                         close(cleanup_fd_w);
 128                 }
 129                 finish_transfer(cleanup_new_fname, fname, NULL,
 130                                 cleanup_file, 0, !partial_dir);
 131         }
 132         io_flush(FULL_FLUSH);
 133         if (cleanup_fname)
 134                 do_unlink(cleanup_fname);
 135         if (code)
 136                 kill_all(SIGUSR1);
 137         if (cleanup_pid && cleanup_pid == getpid()) {
 138                 char *pidf = lp_pid_file();
 139                 if (pidf && *pidf)
 140                         unlink(lp_pid_file());
 141         }
 142
 143         if (code == 0) {
 144                 if (io_error & IOERR_DEL_LIMIT)
 145                         code = RERR_DEL_LIMIT;
 146                 if (io_error & IOERR_VANISHED)
 147                         code = RERR_VANISHED;
 148                 if (io_error & IOERR_GENERAL || log_got_error)
 149                         code = RERR_PARTIAL;
 150         }
 151
 152         if (code)
 153                 log_exit(code, file, line);
 154
 155         if (verbose > 2) {
 156                 rprintf(FINFO,"_exit_cleanup(code=%d, file=%s, line=%d): about to call exit(%d)\n",
 157                         ocode, file, line, code);
 158         }
 159
 160         close_all();
 161         exit(code);
 162 }
 163
 164 void cleanup_disable(void)
 165 {
 166         cleanup_fname = NULL;
 167         cleanup_got_literal = 0;
 168 }
 169
 170
 171 void cleanup_set(char *fnametmp, char *fname, struct file_struct *file,
 172                  int fd_r, int fd_w)
 173 {
 174         cleanup_fname = fname ? fnametmp : NULL;
 175         cleanup_new_fname = fname;
 176         cleanup_file = file;
 177         cleanup_fd_r = fd_r;
 178         cleanup_fd_w = fd_w;
 179 }
 180
 181 void cleanup_set_pid(pid_t pid)
 182 {
 183         cleanup_pid = pid;
 184 }