Annotation of embedaddon/rsync/cleanup.c, revision 1.1.1.3

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>