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