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-2009 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 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 const char *cleanup_fname;
  83 static const 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, exit_line = 0;
  99         static const char *exit_file = NULL;
 100         static int unmodified_code = 0;
 101
 102         SIGACTION(SIGUSR1, SIG_IGN);
 103         SIGACTION(SIGUSR2, SIG_IGN);
 104
 105         if (exit_code) { /* Preserve first exit info when recursing. */
 106                 code = exit_code;
 107                 file = exit_file;
 108                 line = exit_line;
 109         }
 110
 111         /* If this is the exit at the end of the run, the server side
 112          * should not attempt to output a message (see log_exit()). */
 113         if (am_server && code == 0)
 114                 am_server = 2;
 115
 116         /* Some of our actions might cause a recursive call back here, so we
 117          * keep track of where we are in the cleanup and never repeat a step. */
 118         switch (cleanup_step) {
 119 #include "case_N.h" /* case 0: cleanup_step++; */
 120
 121                 exit_code = unmodified_code = code;
 122                 exit_file = file;
 123                 exit_line = line;
 124
 125                 if (verbose > 3) {
 126                         rprintf(FINFO,
 127                                 "[%s] _exit_cleanup(code=%d, file=%s, line=%d): entered\n",
 128                                 who_am_i(), code, file, line);
 129                 }
 130
 131                 /* FALLTHROUGH */
 132 #include "case_N.h"
 133
 134                 if (cleanup_child_pid != -1) {
 135                         int status;
 136                         int pid = wait_process(cleanup_child_pid, &status, WNOHANG);
 137                         if (pid == cleanup_child_pid) {
 138                                 status = WEXITSTATUS(status);
 139                                 if (status > code)
 140                                         code = exit_code = status;
 141                         }
 142                 }
 143
 144                 /* FALLTHROUGH */
 145 #include "case_N.h"
 146
 147                 if (cleanup_got_literal && cleanup_fname && cleanup_new_fname
 148                  && keep_partial && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
 149                         const char *fname = cleanup_fname;
 150                         cleanup_fname = NULL;
 151                         if (cleanup_fd_r != -1)
 152                                 close(cleanup_fd_r);
 153                         if (cleanup_fd_w != -1) {
 154                                 flush_write_file(cleanup_fd_w);
 155                                 close(cleanup_fd_w);
 156                         }
 157                         finish_transfer(cleanup_new_fname, fname, NULL, NULL,
 158                                         cleanup_file, 0, !partial_dir);
 159                 }
 160
 161                 /* FALLTHROUGH */
 162 #include "case_N.h"
 163
 164                 if (!code || am_server || am_receiver)
 165                         io_flush(FULL_FLUSH);
 166
 167                 /* FALLTHROUGH */
 168 #include "case_N.h"
 169
 170                 if (cleanup_fname)
 171                         do_unlink(cleanup_fname);
 172                 if (code)
 173                         kill_all(SIGUSR1);
 174                 if (cleanup_pid && cleanup_pid == getpid()) {
 175                         char *pidf = lp_pid_file();
 176                         if (pidf && *pidf)
 177                                 unlink(lp_pid_file());
 178                 }
 179
 180                 if (code == 0) {
 181                         if (io_error & IOERR_DEL_LIMIT)
 182                                 code = exit_code = RERR_DEL_LIMIT;
 183                         if (io_error & IOERR_VANISHED)
 184                                 code = exit_code = RERR_VANISHED;
 185                         if (io_error & IOERR_GENERAL || got_xfer_error)
 186                                 code = exit_code = RERR_PARTIAL;
 187                 }
 188
 189                 if (code || am_daemon || (logfile_name && (am_server || !verbose)))
 190                         log_exit(code, file, line);
 191
 192                 /* FALLTHROUGH */
 193 #include "case_N.h"
 194
 195                 if (verbose > 2) {
 196                         rprintf(FINFO,
 197                                 "[%s] _exit_cleanup(code=%d, file=%s, line=%d): "
 198                                 "about to call exit(%d)\n",
 199                                 who_am_i(), unmodified_code, file, line, code);
 200                 }
 201
 202                 /* FALLTHROUGH */
 203 #include "case_N.h"
 204
 205                 if (am_server && code)
 206                         msleep(100);
 207                 close_all();
 208
 209                 /* FALLTHROUGH */
 210         default:
 211                 break;
 212         }
 213
 214         exit(code);
 215 }
 216
 217 void cleanup_disable(void)
 218 {
 219         cleanup_fname = cleanup_new_fname = NULL;
 220         cleanup_got_literal = 0;
 221 }
 222
 223
 224 void cleanup_set(const char *fnametmp, const char *fname, struct file_struct *file,
 225                  int fd_r, int fd_w)
 226 {
 227         cleanup_fname = fnametmp;
 228         cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */
 229         cleanup_file = file;
 230         cleanup_fd_r = fd_r;
 231         cleanup_fd_w = fd_w;
 232 }
 233
 234 void cleanup_set_pid(pid_t pid)
 235 {
 236         cleanup_pid = pid;
 237 }