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
  28 /**
  29  * Close all open sockets and files, allowing a (somewhat) graceful
  30  * shutdown() of socket connections.  This eliminates the abortive
  31  * TCP RST sent by a Winsock-based system when the close() occurs.
  32  **/
  33 void close_all(void)
  34 {
  35 #ifdef SHUTDOWN_ALL_SOCKETS
  36         int max_fd;
  37         int fd;
  38         int ret;
  39         struct stat st;
  40
  41         max_fd = sysconf(_SC_OPEN_MAX) - 1;
  42         for (fd = max_fd; fd >= 0; fd--) {
  43                 ret = fstat(fd,&st);
  44                 if (fstat(fd,&st) == 0) {
  45                         if (is_a_socket(fd))
  46                                 ret = shutdown(fd, 2);
  47                         ret = close(fd);
  48                 }
  49         }
  50 #endif
  51 }
  52
  53 /**
  54  * @file cleanup.c
  55  *
  56  * Code for handling interrupted transfers.  Depending on the @c
  57  * --partial option, we may either delete the temporary file, or go
  58  * ahead and overwrite the destination.  This second behaviour only
  59  * occurs if we've sent literal data and therefore hopefully made
  60  * progress on the transfer.
  61  **/
  62
  63 /**
  64  * Set to True once literal data has been sent across the link for the
  65  * current file. (????)
  66  *
  67  * Handling the cleanup when a transfer is interrupted is tricky when
  68  * --partial is selected.  We need to ensure that the partial file is
  69  * kept if any real data has been transferred.
  70  **/
  71 int cleanup_got_literal = 0;
  72
  73 static char *cleanup_fname;
  74 static char *cleanup_new_fname;
  75 static struct file_struct *cleanup_file;
  76 static int cleanup_fd1, cleanup_fd2;
  77 static struct map_struct *cleanup_buf;
  78 static pid_t cleanup_pid = 0;
  79
  80 pid_t cleanup_child_pid = -1;
  81
  82 /**
  83  * Eventually calls exit(), passing @p code, therefore does not return.
  84  *
  85  * @param code one of the RERR_* codes from errcode.h.
  86  **/
  87 void _exit_cleanup(int code, const char *file, int line)
  88 {
  89         int ocode = code;
  90         static int inside_cleanup = 0;
  91
  92         if (inside_cleanup > 10) {
  93                 /* prevent the occasional infinite recursion */
  94                 return;
  95         }
  96         inside_cleanup++;
  97
  98         signal(SIGUSR1, SIG_IGN);
  99         signal(SIGUSR2, SIG_IGN);
 100
 101         if (verbose > 3) {
 102                 rprintf(FINFO,"_exit_cleanup(code=%d, file=%s, line=%d): entered\n",
 103                         code, file, line);
 104         }
 105
 106         if (cleanup_child_pid != -1) {
 107                 int status;
 108                 if (waitpid(cleanup_child_pid, &status, WNOHANG) == cleanup_child_pid) {
 109                         status = WEXITSTATUS(status);
 110                         if (status > code)
 111                                 code = status;
 112                 }
 113         }
 114
 115         if (cleanup_got_literal && cleanup_fname && keep_partial) {
 116                 char *fname = cleanup_fname;
 117                 cleanup_fname = NULL;
 118                 if (cleanup_buf)
 119                         unmap_file(cleanup_buf);
 120                 if (cleanup_fd1 != -1)
 121                         close(cleanup_fd1);
 122                 if (cleanup_fd2 != -1)
 123                         close(cleanup_fd2);
 124                 finish_transfer(cleanup_new_fname, fname, cleanup_file, 0);
 125         }
 126         io_flush(FULL_FLUSH);
 127         if (cleanup_fname)
 128                 do_unlink(cleanup_fname);
 129         if (code)
 130                 kill_all(SIGUSR1);
 131         if (cleanup_pid && cleanup_pid == getpid()) {
 132                 char *pidf = lp_pid_file();
 133                 if (pidf && *pidf)
 134                         unlink(lp_pid_file());
 135         }
 136
 137         if (code == 0) {
 138                 if ((io_error & ~IOERR_VANISHED) || log_got_error)
 139                         code = RERR_PARTIAL;
 140                 else if (io_error)
 141                         code = RERR_VANISHED;
 142         }
 143
 144         if (code)
 145                 log_exit(code, file, line);
 146
 147         if (verbose > 2) {
 148                 rprintf(FINFO,"_exit_cleanup(code=%d, file=%s, line=%d): about to call exit(%d)\n",
 149                         ocode, file, line, code);
 150         }
 151
 152         close_all();
 153         exit(code);
 154 }
 155
 156 void cleanup_disable(void)
 157 {
 158         cleanup_fname = NULL;
 159         cleanup_got_literal = 0;
 160 }
 161
 162
 163 void cleanup_set(char *fnametmp, char *fname, struct file_struct *file,
 164                  struct map_struct *buf, int fd1, int fd2)
 165 {
 166         cleanup_fname = fnametmp;
 167         cleanup_new_fname = fname;
 168         cleanup_file = file;
 169         cleanup_buf = buf;
 170         cleanup_fd1 = fd1;
 171         cleanup_fd2 = fd2;
 172 }
 173
 174 void cleanup_set_pid(pid_t pid)
 175 {
 176         cleanup_pid = pid;
 177 }