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_sender;
  28 extern int am_generator;
  29 extern int io_error;
  30 extern int keep_partial;
  31 extern int got_xfer_error;
  32 extern int protocol_version;
  33 extern int output_needs_newline;
  34 extern char *partial_dir;
  35 extern char *logfile_name;
  36
  37 #ifdef HAVE_SIGACTION
  38 static struct sigaction sigact;
  39 #endif
  40
  41 /**
  42  * Close all open sockets and files, allowing a (somewhat) graceful
  43  * shutdown() of socket connections.  This eliminates the abortive
  44  * TCP RST sent by a Winsock-based system when the close() occurs.
  45  **/
  46 void close_all(void)
  47 {
  48 #ifdef SHUTDOWN_ALL_SOCKETS
  49         int max_fd;
  50         int fd;
  51         int ret;
  52         STRUCT_STAT st;
  53
  54         max_fd = sysconf(_SC_OPEN_MAX) - 1;
  55         for (fd = max_fd; fd >= 0; fd--) {
  56                 if ((ret = do_fstat(fd, &st)) == 0) {
  57                         if (is_a_socket(fd))
  58                                 ret = shutdown(fd, 2);
  59                         ret = close(fd);
  60                 }
  61         }
  62 #endif
  63 }
  64
  65 /**
  66  * @file cleanup.c
  67  *
  68  * Code for handling interrupted transfers.  Depending on the @c
  69  * --partial option, we may either delete the temporary file, or go
  70  * ahead and overwrite the destination.  This second behaviour only
  71  * occurs if we've sent literal data and therefore hopefully made
  72  * progress on the transfer.
  73  **/
  74
  75 /**
  76  * Set to True once literal data has been sent across the link for the
  77  * current file. (????)
  78  *
  79  * Handling the cleanup when a transfer is interrupted is tricky when
  80  * --partial is selected.  We need to ensure that the partial file is
  81  * kept if any real data has been transferred.
  82  **/
  83 int cleanup_got_literal = 0;
  84
  85 static const char *cleanup_fname;
  86 static const char *cleanup_new_fname;
  87 static struct file_struct *cleanup_file;
  88 static int cleanup_fd_r, cleanup_fd_w;
  89 static pid_t cleanup_pid = 0;
  90
  91 pid_t cleanup_child_pid = -1;
  92
  93 /**
  94  * Eventually calls exit(), passing @p code, therefore does not return.
  95  *
  96  * @param code one of the RERR_* codes from errcode.h.
  97  **/
  98 NORETURN void _exit_cleanup(int code, const char *file, int line)
  99 {
 100         static int cleanup_step = 0;
 101         static int exit_code = 0;
 102         static int unmodified_code = 0;
 103
 104         SIGACTION(SIGUSR1, SIG_IGN);
 105         SIGACTION(SIGUSR2, SIG_IGN);
 106
 107         if (exit_code) /* Preserve first error code when recursing. */
 108                 code = exit_code;
 109
 110         /* If this is the exit at the end of the run, the server side
 111          * should not attempt to output a message (see log_exit()). */
 112         if (am_server && code == 0)
 113                 am_server = 2;
 114
 115         /* Some of our actions might cause a recursive call back here, so we
 116          * keep track of where we are in the cleanup and never repeat a step. */
 117         switch (cleanup_step) {
 118 #include "case_N.h" /* case 0: cleanup_step++; */
 119
 120                 exit_code = unmodified_code = code;
 121
 122                 if (output_needs_newline) {
 123                         fputc('\n', stdout);
 124                         output_needs_newline = 0;
 125                 }
 126
 127                 if (DEBUG_GTE(EXIT, 2)) {
 128                         rprintf(FINFO,
 129                                 "_exit_cleanup(code=%d, file=%s, line=%d): entered\n",
 130                                 code, file, line);
 131                 }
 132
 133                 /* FALLTHROUGH */
 134 #include "case_N.h"
 135
 136                 if (exit_code && exit_code != RERR_RCVR_ERROR
 137                  && exit_code != RERR_STREAMIO && exit_code != RERR_SIGNAL1
 138                  && (protocol_version >= 31 || (!am_sender && !am_generator))) {
 139                         send_msg_int(MSG_ERROR_EXIT, exit_code);
 140                         if (am_server && !am_sender && !am_generator)
 141                                 noop_io_until_death();
 142                 }
 143
 144                 /* FALLTHROUGH */
 145 #include "case_N.h"
 146
 147                 if (cleanup_child_pid != -1) {
 148                         int status;
 149                         int pid = wait_process(cleanup_child_pid, &status, WNOHANG);
 150                         if (pid == cleanup_child_pid) {
 151                                 status = WEXITSTATUS(status);
 152                                 if (status > code)
 153                                         code = exit_code = status;
 154                         }
 155                 }
 156
 157                 /* FALLTHROUGH */
 158 #include "case_N.h"
 159
 160                 if (cleanup_got_literal && cleanup_fname && cleanup_new_fname
 161                  && keep_partial && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
 162                         const char *fname = cleanup_fname;
 163                         cleanup_fname = NULL;
 164                         if (cleanup_fd_r != -1)
 165                                 close(cleanup_fd_r);
 166                         if (cleanup_fd_w != -1) {
 167                                 flush_write_file(cleanup_fd_w);
 168                                 close(cleanup_fd_w);
 169                         }
 170                         finish_transfer(cleanup_new_fname, fname, NULL, NULL,
 171                                         cleanup_file, 0, !partial_dir);
 172                 }
 173
 174                 /* FALLTHROUGH */
 175 #include "case_N.h"
 176
 177                 if (!code || am_server || (!am_sender && !am_generator))
 178                         io_flush(FULL_FLUSH);
 179
 180                 /* FALLTHROUGH */
 181 #include "case_N.h"
 182
 183                 if (cleanup_fname)
 184                         do_unlink(cleanup_fname);
 185                 if (code)
 186                         kill_all(SIGUSR1);
 187                 if (cleanup_pid && cleanup_pid == getpid()) {
 188                         char *pidf = lp_pid_file();
 189                         if (pidf && *pidf)
 190                                 unlink(lp_pid_file());
 191                 }
 192
 193                 if (code == 0) {
 194                         if (io_error & IOERR_DEL_LIMIT)
 195                                 code = exit_code = RERR_DEL_LIMIT;
 196                         if (io_error & IOERR_VANISHED)
 197                                 code = exit_code = RERR_VANISHED;
 198                         if (io_error & IOERR_GENERAL || got_xfer_error)
 199                                 code = exit_code = RERR_PARTIAL;
 200                 }
 201
 202                 if ((code && code != RERR_RCVR_ERROR)
 203                  || am_daemon || (logfile_name && (am_server || !INFO_GTE(STATS, 1))))
 204                         log_exit(code, file, line);
 205
 206                 /* FALLTHROUGH */
 207 #include "case_N.h"
 208
 209                 if (DEBUG_GTE(EXIT, 1)) {
 210                         rprintf(FINFO,
 211                                 "_exit_cleanup(code=%d, file=%s, line=%d): "
 212                                 "about to call exit(%d)\n",
 213                                 unmodified_code, file, line, code);
 214                 }
 215
 216                 /* FALLTHROUGH */
 217 #include "case_N.h"
 218
 219                 if (am_server && code)
 220                         msleep(100);
 221                 close_all();
 222
 223                 /* FALLTHROUGH */
 224         default:
 225                 break;
 226         }
 227
 228         exit(code);
 229 }
 230
 231 void cleanup_disable(void)
 232 {
 233         cleanup_fname = cleanup_new_fname = NULL;
 234         cleanup_got_literal = 0;
 235 }
 236
 237
 238 void cleanup_set(const char *fnametmp, const char *fname, struct file_struct *file,
 239                  int fd_r, int fd_w)
 240 {
 241         cleanup_fname = fnametmp;
 242         cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */
 243         cleanup_file = file;
 244         cleanup_fd_r = fd_r;
 245         cleanup_fd_w = fd_w;
 246 }
 247
 248 void cleanup_set_pid(pid_t pid)
 249 {
 250         cleanup_pid = pid;
 251 }