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