Mention updated config files.
[rsync.git] / cleanup.c
index 19ef072cd1dec650c9d5aee2cd12c4decc8af74d..40d26baa8f8f79b2bb6b330910036169acb3314f 100644 (file)
--- a/cleanup.c
+++ b/cleanup.c
@@ -4,7 +4,7 @@
  * Copyright (C) 1996-2000 Andrew Tridgell
  * Copyright (C) 1996 Paul Mackerras
  * Copyright (C) 2002 Martin Pool
- * Copyright (C) 2003-2009 Wayne Davison
+ * Copyright (C) 2003-2020 Wayne Davison
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 
 #include "rsync.h"
 
+extern int dry_run;
 extern int am_server;
 extern int am_daemon;
+extern int am_receiver;
+extern int am_sender;
 extern int io_error;
 extern int keep_partial;
 extern int got_xfer_error;
+extern int protocol_version;
 extern int output_needs_newline;
 extern char *partial_dir;
 extern char *logfile_name;
 
+int called_from_signal_handler = 0;
+BOOL shutting_down = False;
+BOOL flush_ok_after_signal = False;
+
 #ifdef HAVE_SIGACTION
 static struct sigaction sigact;
 #endif
@@ -82,7 +90,7 @@ int cleanup_got_literal = 0;
 static const char *cleanup_fname;
 static const char *cleanup_new_fname;
 static struct file_struct *cleanup_file;
-static int cleanup_fd_r, cleanup_fd_w;
+static int cleanup_fd_r = -1, cleanup_fd_w = -1;
 static pid_t cleanup_pid = 0;
 
 pid_t cleanup_child_pid = -1;
@@ -94,15 +102,19 @@ pid_t cleanup_child_pid = -1;
  **/
 NORETURN void _exit_cleanup(int code, const char *file, int line)
 {
-       static int cleanup_step = 0;
-       static int exit_code = 0;
-       static int unmodified_code = 0;
+       static int switch_step = 0;
+       static int exit_code = 0, exit_line = 0;
+       static const char *exit_file = NULL;
+       static int first_code = 0;
 
        SIGACTION(SIGUSR1, SIG_IGN);
        SIGACTION(SIGUSR2, SIG_IGN);
 
-       if (exit_code) /* Preserve first error code when recursing. */
-               code = exit_code;
+       if (!exit_code) { /* Preserve first error exit info when recursing. */
+               exit_code = code;
+               exit_file = file;
+               exit_line = line < 0 ? -line : line;
+       }
 
        /* If this is the exit at the end of the run, the server side
         * should not attempt to output a message (see log_exit()). */
@@ -111,10 +123,11 @@ NORETURN void _exit_cleanup(int code, const char *file, int line)
 
        /* Some of our actions might cause a recursive call back here, so we
         * keep track of where we are in the cleanup and never repeat a step. */
-       switch (cleanup_step) {
-#include "case_N.h" /* case 0: cleanup_step++; */
+       switch (switch_step) {
+#include "case_N.h" /* case 0: */
+               switch_step++;
 
-               exit_code = unmodified_code = code;
+               first_code = code;
 
                if (output_needs_newline) {
                        fputc('\n', stdout);
@@ -123,51 +136,70 @@ NORETURN void _exit_cleanup(int code, const char *file, int line)
 
                if (DEBUG_GTE(EXIT, 2)) {
                        rprintf(FINFO,
-                               "_exit_cleanup(code=%d, file=%s, line=%d): entered\n",
-                               code, file, line);
+                               "[%s] _exit_cleanup(code=%d, file=%s, line=%d): entered\n",
+                               who_am_i(), code, src_file(file), line);
                }
 
-               /* FALLTHROUGH */
 #include "case_N.h"
+               switch_step++;
 
                if (cleanup_child_pid != -1) {
                        int status;
                        int pid = wait_process(cleanup_child_pid, &status, WNOHANG);
                        if (pid == cleanup_child_pid) {
                                status = WEXITSTATUS(status);
-                               if (status > code)
-                                       code = exit_code = status;
+                               if (status > exit_code)
+                                       exit_code = status;
                        }
                }
 
-               /* FALLTHROUGH */
 #include "case_N.h"
+               switch_step++;
 
-               if (cleanup_got_literal && cleanup_fname && cleanup_new_fname
-                && keep_partial && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
-                       const char *fname = cleanup_fname;
-                       cleanup_fname = NULL;
-                       if (cleanup_fd_r != -1)
+               if (cleanup_got_literal && (cleanup_fname || cleanup_fd_w != -1)) {
+                       if (cleanup_fd_r != -1) {
                                close(cleanup_fd_r);
+                               cleanup_fd_r = -1;
+                       }
                        if (cleanup_fd_w != -1) {
                                flush_write_file(cleanup_fd_w);
                                close(cleanup_fd_w);
+                               cleanup_fd_w = -1;
+                       }
+                       if (cleanup_fname && cleanup_new_fname && keep_partial
+                        && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
+                               int tweak_modtime = 0;
+                               const char *fname = cleanup_fname;
+                               cleanup_fname = NULL;
+                               if (!partial_dir) {
+                                       /* We don't want to leave a partial file with a modern time or it
+                                        * could be skipped via --update.  Setting the time to something
+                                        * really old also helps it to stand out as unfinished in an ls. */
+                                       tweak_modtime = 1;
+                                       cleanup_file->modtime = 0;
+                               }
+                               finish_transfer(cleanup_new_fname, fname, NULL, NULL,
+                                               cleanup_file, tweak_modtime, !partial_dir);
                        }
-                       finish_transfer(cleanup_new_fname, fname, NULL, NULL,
-                                       cleanup_file, 0, !partial_dir);
                }
 
-               /* FALLTHROUGH */
 #include "case_N.h"
+               switch_step++;
 
-               io_flush(FULL_FLUSH);
+               if (flush_ok_after_signal) {
+                       flush_ok_after_signal = False;
+                       if (code == RERR_SIGNAL)
+                               io_flush(FULL_FLUSH);
+               }
+               if (!exit_code && !code)
+                       io_flush(FULL_FLUSH);
 
-               /* FALLTHROUGH */
 #include "case_N.h"
+               switch_step++;
 
                if (cleanup_fname)
                        do_unlink(cleanup_fname);
-               if (code)
+               if (exit_code)
                        kill_all(SIGUSR1);
                if (cleanup_pid && cleanup_pid == getpid()) {
                        char *pidf = lp_pid_file();
@@ -175,32 +207,60 @@ NORETURN void _exit_cleanup(int code, const char *file, int line)
                                unlink(lp_pid_file());
                }
 
-               if (code == 0) {
+               if (exit_code == 0) {
+                       if (code)
+                               exit_code = code;
                        if (io_error & IOERR_DEL_LIMIT)
-                               code = exit_code = RERR_DEL_LIMIT;
+                               exit_code = RERR_DEL_LIMIT;
                        if (io_error & IOERR_VANISHED)
-                               code = exit_code = RERR_VANISHED;
+                               exit_code = RERR_VANISHED;
                        if (io_error & IOERR_GENERAL || got_xfer_error)
-                               code = exit_code = RERR_PARTIAL;
+                               exit_code = RERR_PARTIAL;
                }
 
-               if (code || am_daemon || (logfile_name && (am_server || !INFO_GTE(STATS, 1))))
-                       log_exit(code, file, line);
+               /* If line < 0, this exit is after a MSG_ERROR_EXIT event, so
+                * we don't want to output a duplicate error. */
+               if ((exit_code && line > 0)
+                || am_daemon || (logfile_name && (am_server || !INFO_GTE(STATS, 1)))) {
+                       log_exit(exit_code, exit_file, exit_line);
+               }
 
-               /* FALLTHROUGH */
 #include "case_N.h"
+               switch_step++;
 
                if (DEBUG_GTE(EXIT, 1)) {
                        rprintf(FINFO,
-                               "_exit_cleanup(code=%d, file=%s, line=%d): "
-                               "about to call exit(%d)\n",
-                               unmodified_code, file, line, code);
+                               "[%s] _exit_cleanup(code=%d, file=%s, line=%d): "
+                               "about to call exit(%d)%s\n",
+                               who_am_i(), first_code, exit_file, exit_line, exit_code,
+                               dry_run ? " (DRY RUN)" : "");
+               }
+
+#include "case_N.h"
+               switch_step++;
+
+               if (exit_code && exit_code != RERR_SOCKETIO && exit_code != RERR_STREAMIO && exit_code != RERR_SIGNAL1
+                && exit_code != RERR_TIMEOUT && !shutting_down) {
+                       if (protocol_version >= 31 || am_receiver) {
+                               if (line > 0) {
+                                       if (DEBUG_GTE(EXIT, 3)) {
+                                               rprintf(FINFO, "[%s] sending MSG_ERROR_EXIT with exit_code %d\n",
+                                                       who_am_i(), exit_code);
+                                       }
+                                       send_msg_int(MSG_ERROR_EXIT, exit_code);
+                               }
+                               if (!am_sender)
+                                       io_flush(MSG_FLUSH); /* Be sure to send all messages */
+                               noop_io_until_death();
+                       }
+                       else if (!am_sender)
+                               io_flush(MSG_FLUSH); /* Be sure to send all messages */
                }
 
-               /* FALLTHROUGH */
 #include "case_N.h"
+               switch_step++;
 
-               if (am_server && code)
+               if (am_server && exit_code)
                        msleep(100);
                close_all();
 
@@ -209,12 +269,15 @@ NORETURN void _exit_cleanup(int code, const char *file, int line)
                break;
        }
 
-       exit(code);
+       if (called_from_signal_handler)
+               _exit(exit_code);
+       exit(exit_code);
 }
 
 void cleanup_disable(void)
 {
        cleanup_fname = cleanup_new_fname = NULL;
+       cleanup_fd_r = cleanup_fd_w = -1;
        cleanup_got_literal = 0;
 }