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