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