Man page: Move the description of --info=progress2 to a better place.
[rsync/rsync.git] / cleanup.c
index 1acc348..cf5f212 100644 (file)
--- a/cleanup.c
+++ b/cleanup.c
@@ -4,11 +4,11 @@
  * Copyright (C) 1996-2000 Andrew Tridgell
  * Copyright (C) 1996 Paul Mackerras
  * Copyright (C) 2002 Martin Pool
- * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
+ * Copyright (C) 2003-2009 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
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, visit the http://fsf.org website.
  */
 
 #include "rsync.h"
 
+extern int am_server;
+extern int am_daemon;
+extern int am_receiver;
 extern int io_error;
 extern int keep_partial;
-extern int log_got_error;
+extern int got_xfer_error;
+extern int protocol_version;
+extern int output_needs_newline;
 extern char *partial_dir;
+extern char *logfile_name;
+
+BOOL shutting_down = False;
 
 #ifdef HAVE_SIGACTION
 static struct sigaction sigact;
@@ -76,8 +83,8 @@ void close_all(void)
  **/
 int cleanup_got_literal = 0;
 
-static char *cleanup_fname;
-static char *cleanup_new_fname;
+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 pid_t cleanup_pid = 0;
@@ -89,92 +96,171 @@ pid_t cleanup_child_pid = -1;
  *
  * @param code one of the RERR_* codes from errcode.h.
  **/
-void _exit_cleanup(int code, const char *file, int line)
+NORETURN void _exit_cleanup(int code, const char *file, int line)
 {
-       int ocode = code;
-       static int inside_cleanup = 0;
-
-       if (inside_cleanup > 10) {
-               /* prevent the occasional infinite recursion */
-               return;
-       }
-       inside_cleanup++;
+       static int switch_step = 0;
+       static int exit_code = 0, exit_line = 0;
+       static const char *exit_file = NULL;
+       static int unmodified_code = 0;
 
        SIGACTION(SIGUSR1, SIG_IGN);
        SIGACTION(SIGUSR2, SIG_IGN);
 
-       if (verbose > 3) {
-               rprintf(FINFO,"_exit_cleanup(code=%d, file=%s, line=%d): entered\n",
-                       code, file, line);
+       if (exit_code) { /* Preserve first exit info when recursing. */
+               code = exit_code;
+               file = exit_file;
+               line = exit_line;
        }
 
-       if (cleanup_child_pid != -1) {
-               int status;
-               if (wait_process(cleanup_child_pid, &status, WNOHANG)
-                == cleanup_child_pid) {
-                       status = WEXITSTATUS(status);
-                       if (status > code)
-                               code = status;
+       /* If this is the exit at the end of the run, the server side
+        * should not attempt to output a message (see log_exit()). */
+       if (am_server && code == 0)
+               am_server = 2;
+
+       /* 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 (switch_step) {
+#include "case_N.h" /* case 0: */
+               switch_step++;
+
+               exit_code = unmodified_code = code;
+               exit_file = file;
+               exit_line = line;
+
+               if (output_needs_newline) {
+                       fputc('\n', stdout);
+                       output_needs_newline = 0;
                }
-       }
 
-       if (cleanup_got_literal && cleanup_fname && keep_partial
-           && handle_partial_dir(cleanup_new_fname, PDIR_CREATE)) {
-               char *fname = cleanup_fname;
-               cleanup_fname = NULL;
-               if (cleanup_fd_r != -1)
-                       close(cleanup_fd_r);
-               if (cleanup_fd_w != -1) {
-                       flush_write_file(cleanup_fd_w);
-                       close(cleanup_fd_w);
+               if (DEBUG_GTE(EXIT, 2)) {
+                       rprintf(FINFO,
+                               "[%s] _exit_cleanup(code=%d, file=%s, line=%d): entered\n",
+                               who_am_i(), code, file, line);
                }
-               finish_transfer(cleanup_new_fname, fname, NULL,
-                               cleanup_file, 0, !partial_dir);
-       }
-       io_flush(FULL_FLUSH);
-       if (cleanup_fname)
-               do_unlink(cleanup_fname);
-       if (code)
-               kill_all(SIGUSR1);
-       if (cleanup_pid && cleanup_pid == getpid()) {
-               char *pidf = lp_pid_file();
-               if (pidf && *pidf)
-                       unlink(lp_pid_file());
-       }
 
-       if (code == 0) {
-               if (io_error & IOERR_DEL_LIMIT)
-                       code = RERR_DEL_LIMIT;
-               if (io_error & IOERR_VANISHED)
-                       code = RERR_VANISHED;
-               if (io_error & IOERR_GENERAL || log_got_error)
-                       code = RERR_PARTIAL;
-       }
+               /* 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;
+                       }
+               }
+
+               /* 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)
+                               close(cleanup_fd_r);
+                       if (cleanup_fd_w != -1) {
+                               flush_write_file(cleanup_fd_w);
+                               close(cleanup_fd_w);
+                       }
+                       finish_transfer(cleanup_new_fname, fname, NULL, NULL,
+                                       cleanup_file, 0, !partial_dir);
+               }
+
+               /* FALLTHROUGH */
+#include "case_N.h"
+               switch_step++;
+
+               if (!code || am_server || am_receiver)
+                       io_flush(FULL_FLUSH);
+
+               /* FALLTHROUGH */
+#include "case_N.h"
+               switch_step++;
+
+               if (cleanup_fname)
+                       do_unlink(cleanup_fname);
+               if (code)
+                       kill_all(SIGUSR1);
+               if (cleanup_pid && cleanup_pid == getpid()) {
+                       char *pidf = lp_pid_file();
+                       if (pidf && *pidf)
+                               unlink(lp_pid_file());
+               }
+
+               if (code == 0) {
+                       if (io_error & IOERR_DEL_LIMIT)
+                               code = exit_code = RERR_DEL_LIMIT;
+                       if (io_error & IOERR_VANISHED)
+                               code = exit_code = RERR_VANISHED;
+                       if (io_error & IOERR_GENERAL || got_xfer_error)
+                               code = exit_code = RERR_PARTIAL;
+               }
+
+               /* If line < 0, this exit is after a MSG_ERROR_EXIT event, so
+                * we don't want to output a duplicate error. */
+               if ((code && line > 0)
+                || am_daemon || (logfile_name && (am_server || !INFO_GTE(STATS, 1))))
+                       log_exit(code, file, line);
+
+               /* FALLTHROUGH */
+#include "case_N.h"
+               switch_step++;
+
+               if (DEBUG_GTE(EXIT, 1)) {
+                       rprintf(FINFO,
+                               "[%s] _exit_cleanup(code=%d, file=%s, line=%d): "
+                               "about to call exit(%d)\n",
+                               who_am_i(), unmodified_code, file, line, code);
+               }
+
+               /* FALLTHROUGH */
+#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 && (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);
+                       }
+                       noop_io_until_death();
+               }
+
+               /* FALLTHROUGH */
+#include "case_N.h"
+               switch_step++;
 
-       if (code)
-               log_exit(code, file, line);
+               if (am_server && code)
+                       msleep(100);
+               close_all();
 
-       if (verbose > 2) {
-               rprintf(FINFO,"_exit_cleanup(code=%d, file=%s, line=%d): about to call exit(%d)\n",
-                       ocode, file, line, code);
+               /* FALLTHROUGH */
+       default:
+               break;
        }
 
-       close_all();
        exit(code);
 }
 
 void cleanup_disable(void)
 {
-       cleanup_fname = NULL;
+       cleanup_fname = cleanup_new_fname = NULL;
        cleanup_got_literal = 0;
 }
 
 
-void cleanup_set(char *fnametmp, char *fname, struct file_struct *file,
+void cleanup_set(const char *fnametmp, const char *fname, struct file_struct *file,
                 int fd_r, int fd_w)
 {
-       cleanup_fname = fname ? fnametmp : NULL;
-       cleanup_new_fname = fname;
+       cleanup_fname = fnametmp;
+       cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */
        cleanup_file = file;
        cleanup_fd_r = fd_r;
        cleanup_fd_w = fd_w;