New logging categories added to allow differentiation between
[rsync/rsync.git] / cleanup.c
index 480c200..63fd64e 100644 (file)
--- a/cleanup.c
+++ b/cleanup.c
-/* -*- c-file-style: "linux" -*-
-   
-   Copyright (C) 1996-2000 by Andrew Tridgell
-   Copyright (C) Paul Mackerras 1996
-   
-   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
-   (at your option) any later version.
-   
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   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., 675 Mass Ave, Cambridge, MA 02139, USA.
-*/
+/*
+ * End-of-run cleanup routines.
+ *
+ * Copyright (C) 1996-2000 Andrew Tridgell
+ * Copyright (C) 1996 Paul Mackerras
+ * Copyright (C) 2002 Martin Pool
+ * Copyright (C) 2003-2007 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 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * 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, visit the http://fsf.org website.
+ */
 
 #include "rsync.h"
 
-/* handling the cleanup when a transfer is interrupted is tricky when
-   --partial is selected. We need to ensure that the partial file is
-   kept if any real data has been transferred */
-int cleanup_got_literal=0;
+extern int am_server;
+extern int am_daemon;
+extern int io_error;
+extern int keep_partial;
+extern int got_xfer_error;
+extern char *partial_dir;
+extern char *logfile_name;
+
+#ifdef HAVE_SIGACTION
+static struct sigaction sigact;
+#endif
+
+/**
+ * Close all open sockets and files, allowing a (somewhat) graceful
+ * shutdown() of socket connections.  This eliminates the abortive
+ * TCP RST sent by a Winsock-based system when the close() occurs.
+ **/
+void close_all(void)
+{
+#ifdef SHUTDOWN_ALL_SOCKETS
+       int max_fd;
+       int fd;
+       int ret;
+       STRUCT_STAT st;
+
+       max_fd = sysconf(_SC_OPEN_MAX) - 1;
+       for (fd = max_fd; fd >= 0; fd--) {
+               if ((ret = do_fstat(fd, &st)) == 0) {
+                       if (is_a_socket(fd))
+                               ret = shutdown(fd, 2);
+                       ret = close(fd);
+               }
+       }
+#endif
+}
+
+/**
+ * @file cleanup.c
+ *
+ * Code for handling interrupted transfers.  Depending on the @c
+ * --partial option, we may either delete the temporary file, or go
+ * ahead and overwrite the destination.  This second behaviour only
+ * occurs if we've sent literal data and therefore hopefully made
+ * progress on the transfer.
+ **/
 
-static char *cleanup_fname;
-static char *cleanup_new_fname;
+/**
+ * Set to True once literal data has been sent across the link for the
+ * current file. (????)
+ *
+ * Handling the cleanup when a transfer is interrupted is tricky when
+ * --partial is selected.  We need to ensure that the partial file is
+ * kept if any real data has been transferred.
+ **/
+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_fd1, cleanup_fd2;
-static struct map_struct *cleanup_buf;
-static int cleanup_pid = 0;
-extern int io_error;
+static int cleanup_fd_r, cleanup_fd_w;
+static pid_t cleanup_pid = 0;
 
 pid_t cleanup_child_pid = -1;
 
-/*
- * Code is one of the RERR_* codes from errcode.h.
- */
-void _exit_cleanup(int code, const char *file, int line)
+/**
+ * Eventually calls exit(), passing @p code, therefore does not return.
+ *
+ * @param code one of the RERR_* codes from errcode.h.
+ **/
+NORETURN void _exit_cleanup(int code, const char *file, int line)
 {
-       extern int keep_partial;
-       extern int log_got_error;
+       static int cleanup_step = 0;
+       static int exit_code = 0;
+       static int unmodified_code = 0;
+
+       SIGACTION(SIGUSR1, SIG_IGN);
+       SIGACTION(SIGUSR2, SIG_IGN);
 
-       signal(SIGUSR1, SIG_IGN);
-       signal(SIGUSR2, SIG_IGN);
+       if (exit_code) /* Preserve first error code when recursing. */
+               code = exit_code;
 
-       if (cleanup_child_pid != -1) {
-               int status;
-               if (waitpid(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.c). */
+       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 (cleanup_step) {
+#include "case_N.h" /* case 0: cleanup_step++; */
+
+               exit_code = unmodified_code = code;
+
+               if (verbose > 3) {
+                       rprintf(FINFO,
+                               "_exit_cleanup(code=%d, file=%s, line=%d): entered\n",
+                               code, file, line);
                }
-       }
 
-       if (cleanup_got_literal && cleanup_fname && keep_partial) {
-               char *fname = cleanup_fname;
-               cleanup_fname = NULL;
-               if (cleanup_buf) unmap_file(cleanup_buf);
-               if (cleanup_fd1 != -1) close(cleanup_fd1);
-               if (cleanup_fd2 != -1) close(cleanup_fd2);
-               finish_transfer(cleanup_new_fname, fname, cleanup_file);
-       }
-       io_flush();
-       if (cleanup_fname)
-               do_unlink(cleanup_fname);
-       if (code) {
-               kill_all(SIGUSR1);
-       }
-       if ((cleanup_pid != 0) && (cleanup_pid == (int) getpid())) {
-               char *pidf = lp_pid_file();
-               if (pidf && *pidf) {
-                       unlink(lp_pid_file());
+               /* FALLTHROUGH */
+#include "case_N.h"
+
+               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 (code == 0 && (io_error || log_got_error)) {
-               code = RERR_PARTIAL;
-       }
+               /* FALLTHROUGH */
+#include "case_N.h"
+
+               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"
+
+               io_flush(FULL_FLUSH);
+
+               /* FALLTHROUGH */
+#include "case_N.h"
+
+               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 (code || am_daemon || (logfile_name && (am_server || !verbose)))
+                       log_exit(code, file, line);
+
+               /* FALLTHROUGH */
+#include "case_N.h"
 
-       if (code) log_exit(code, file, line);
+               if (verbose > 2) {
+                       rprintf(FINFO,
+                               "_exit_cleanup(code=%d, file=%s, line=%d): "
+                               "about to call exit(%d)\n",
+                               unmodified_code, file, line, code);
+               }
+
+               /* FALLTHROUGH */
+#include "case_N.h"
+
+               if (am_server && code)
+                       msleep(100);
+               close_all();
+
+               /* FALLTHROUGH */
+       default:
+               break;
+       }
 
        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,
-                struct map_struct *buf, int fd1, int fd2)
+void cleanup_set(const char *fnametmp, const char *fname, struct file_struct *file,
+                int fd_r, int fd_w)
 {
        cleanup_fname = fnametmp;
-       cleanup_new_fname = fname;
+       cleanup_new_fname = fname; /* can be NULL on a partial-dir failure */
        cleanup_file = file;
-       cleanup_buf = buf;
-       cleanup_fd1 = fd1;
-       cleanup_fd2 = fd2;
+       cleanup_fd_r = fd_r;
+       cleanup_fd_w = fd_w;
 }
 
-void cleanup_set_pid(int pid)
+void cleanup_set_pid(pid_t pid)
 {
        cleanup_pid = pid;
 }