14947

pending completion

Build # 14947

Build Type

push

travis-ci

Committed by

locker

Commit Message

Forbid -DENABLE_ASAN=ON with GCC explicitly

The build time error is confusing for users. The patch makes the error
explicit and moves it to the cmake stage.

Follow up of #3070.

(cherry picked from commit d79a1bce4)

Run Details

41041 of 49943 relevant lines covered (82.18%)

855819.47 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.6

/src/box/relay.cc

/*
 * Copyright 2010-2016, Tarantool AUTHORS, please see AUTHORS file.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above
 *    copyright notice, this list of conditions and the
 *    following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
#include "relay.h"

#include "trivia/config.h"
#include "trivia/util.h"
#include "scoped_guard.h"
#include "cbus.h"
#include "cfg.h"
#include "errinj.h"
#include "fiber.h"
#include "say.h"

#include "coio.h"
#include "coio_task.h"
#include "engine.h"
#include "gc.h"
#include "iproto_constants.h"
#include "recovery.h"
#include "replication.h"
#include "trigger.h"
#include "vclock.h"
#include "version.h"
#include "xrow.h"
#include "xrow_io.h"
#include "xstream.h"
#include "wal.h"

/**
 * Cbus message to send status updates from relay to tx thread.
 */
struct relay_status_msg {
        /** Parent */
        struct cmsg msg;
        /** Relay instance */
        struct relay *relay;
        /** Replica vclock. */
        struct vclock vclock;
};

/**
 * Cbus message to update replica gc state in tx thread.
 */
struct relay_gc_msg {
        /** Parent */
        struct cmsg msg;
        /**
         * Link in the list of pending gc messages,
         * see relay::pending_gc.
         */
        struct stailq_entry in_pending;
        /** Relay instance */
        struct relay *relay;
        /** Vclock to advance to */
        struct vclock vclock;
};

/** State of a replication relay. */
struct relay {
        /** The thread in which we relay data to the replica. */
        struct cord cord;
        /** Replica connection */
        struct ev_io io;
        /** Request sync */
        uint64_t sync;
        /** Recovery instance to read xlog from the disk */
        struct recovery *r;
        /** Xstream argument to recovery */
        struct xstream stream;
        /** Vclock to stop playing xlogs */
        struct vclock stop_vclock;
        /** Remote replica */
        struct replica *replica;
        /** WAL event watcher. */
        struct wal_watcher wal_watcher;
        /** Relay reader cond. */
        struct fiber_cond reader_cond;
        /** Relay diagnostics. */
        struct diag diag;
        /** Vclock recieved from replica. */
        struct vclock recv_vclock;
        /** Replicatoin slave version. */
        uint32_t version_id;
        /**
         * Local vclock at the moment of subscribe, used to check
         * dataset on the other side and send missing data rows if any.
         */
        struct vclock local_vclock_at_subscribe;

        /** Relay endpoint */
        struct cbus_endpoint endpoint;
        /** A pipe from 'relay' thread to 'tx' */
        struct cpipe tx_pipe;
        /** A pipe from 'tx' thread to 'relay' */
        struct cpipe relay_pipe;
        /** Status message */
        struct relay_status_msg status_msg;
        /**
         * List of garbage collection messages awaiting
         * confirmation from the replica.
         */
        struct stailq pending_gc;
        /** Time when last row was sent to peer. */
        double last_row_tm;
        /** Relay sync state. */
        enum relay_state state;

        struct {
                /* Align to prevent false-sharing with tx thread */
                alignas(CACHELINE_SIZE)
                /** Known relay vclock. */
                struct vclock vclock;
        } tx;
};

struct diag*
relay_get_diag(struct relay *relay)
{
        return &relay->diag;
}

enum relay_state
relay_get_state(const struct relay *relay)
{
        return relay->state;
}

const struct vclock *
relay_vclock(const struct relay *relay)
{
        return &relay->tx.vclock;
}

static void
relay_send(struct relay *relay, struct xrow_header *packet);
static void
relay_send_initial_join_row(struct xstream *stream, struct xrow_header *row);
static void
relay_send_row(struct xstream *stream, struct xrow_header *row);

struct relay *
relay_new(struct replica *replica)
{
        struct relay *relay = (struct relay *) calloc(1, sizeof(struct relay));
        if (relay == NULL) {
                diag_set(OutOfMemory, sizeof(struct relay), "malloc",
                          "struct relay");
                return NULL;
        }
        relay->replica = replica;
        fiber_cond_create(&relay->reader_cond);
        diag_create(&relay->diag);
        stailq_create(&relay->pending_gc);
        relay->state = RELAY_OFF;
        return relay;
}

static void
relay_start(struct relay *relay, int fd, uint64_t sync,
             void (*stream_write)(struct xstream *, struct xrow_header *))
{
        xstream_create(&relay->stream, stream_write);
        /*
         * Clear the diagnostics at start, in case it has the old
         * error message which we keep around to display in
         * box.info.replication.
         */
        diag_clear(&relay->diag);
        coio_create(&relay->io, fd);
        relay->sync = sync;
        relay->state = RELAY_FOLLOW;
}

void
relay_cancel(struct relay *relay)
{
        /* Check that the thread is running first. */
        if (relay->cord.id != 0) {
                if (tt_pthread_cancel(relay->cord.id) == ESRCH)
                        return;
                tt_pthread_join(relay->cord.id, NULL);
        }
}

static void
relay_stop(struct relay *relay)
{
        struct relay_gc_msg *gc_msg, *next_gc_msg;
        stailq_foreach_entry_safe(gc_msg, next_gc_msg,
                                  &relay->pending_gc, in_pending) {
                free(gc_msg);
        }
        stailq_create(&relay->pending_gc);
        if (relay->r != NULL)
                recovery_delete(relay->r);
        relay->r = NULL;
        relay->state = RELAY_STOPPED;
        /*
         * Needed to track whether relay thread is running or not
         * for relay_cancel(). Id is reset to a positive value
         * upon cord_create().
         */
        relay->cord.id = 0;
}

void
relay_delete(struct relay *relay)
{
        if (relay->state == RELAY_FOLLOW)
                relay_stop(relay);
        fiber_cond_destroy(&relay->reader_cond);
        diag_destroy(&relay->diag);
        TRASH(relay);
        free(relay);
}

static void
relay_set_cord_name(int fd)
{
        char name[FIBER_NAME_MAX];
        struct sockaddr_storage peer;
        socklen_t addrlen = sizeof(peer);
        if (getpeername(fd, ((struct sockaddr*)&peer), &addrlen) == 0) {
                snprintf(name, sizeof(name), "relay/%s",
                         sio_strfaddr((struct sockaddr *)&peer, addrlen));
        } else {
                snprintf(name, sizeof(name), "relay/<unknown>");
        }
        cord_set_name(name);
}

void
relay_initial_join(int fd, uint64_t sync, struct vclock *vclock)
{
        struct relay *relay = relay_new(NULL);
        if (relay == NULL)
                diag_raise();

        relay_start(relay, fd, sync, relay_send_initial_join_row);
        auto relay_guard = make_scoped_guard([=] {
                relay_stop(relay);
                relay_delete(relay);
        });

        engine_join_xc(vclock, &relay->stream);
}

int
relay_final_join_f(va_list ap)
{
        struct relay *relay = va_arg(ap, struct relay *);
        coio_enable();
        relay_set_cord_name(relay->io.fd);

        /* Send all WALs until stop_vclock */
        assert(relay->stream.write != NULL);
        recover_remaining_wals(relay->r, &relay->stream,
                               &relay->stop_vclock, true);
        assert(vclock_compare(&relay->r->vclock, &relay->stop_vclock) == 0);
        return 0;
}

void
relay_final_join(int fd, uint64_t sync, struct vclock *start_vclock,
                 struct vclock *stop_vclock)
{
        struct relay *relay = relay_new(NULL);
        if (relay == NULL)
                diag_raise();

        relay_start(relay, fd, sync, relay_send_row);
        auto relay_guard = make_scoped_guard([=] {
                relay_stop(relay);
                relay_delete(relay);
        });

        relay->r = recovery_new(cfg_gets("wal_dir"),
                               cfg_geti("force_recovery"),
                               start_vclock);
        vclock_copy(&relay->stop_vclock, stop_vclock);

        int rc = cord_costart(&relay->cord, "final_join",
                              relay_final_join_f, relay);
        if (rc == 0)
                rc = cord_cojoin(&relay->cord);
        if (rc != 0)
                diag_raise();

        ERROR_INJECT(ERRINJ_RELAY_FINAL_JOIN,
                     tnt_raise(ClientError, ER_INJECTION, "relay final join"));

        ERROR_INJECT(ERRINJ_RELAY_FINAL_SLEEP, {
                while (vclock_compare(stop_vclock, &replicaset.vclock) == 0)
                        fiber_sleep(0.001);
        });
}

/**
 * The message which updated tx thread with a new vclock has returned back
 * to the relay.
 */
static void
relay_status_update(struct cmsg *msg)
{
        msg->route = NULL;
}

/**
 * Deliver a fresh relay vclock to tx thread.
 */
static void
tx_status_update(struct cmsg *msg)
{
        struct relay_status_msg *status = (struct relay_status_msg *)msg;
        vclock_copy(&status->relay->tx.vclock, &status->vclock);
        static const struct cmsg_hop route[] = {
                {relay_status_update, NULL}
        };
        cmsg_init(msg, route);
        cpipe_push(&status->relay->relay_pipe, msg);
}

/**
 * Update replica gc state in tx thread.
 */
static void
tx_gc_advance(struct cmsg *msg)
{
        struct relay_gc_msg *m = (struct relay_gc_msg *)msg;
        gc_consumer_advance(m->relay->replica->gc, &m->vclock);
        free(m);
}

static void
relay_on_close_log_f(struct trigger *trigger, void * /* event */)
{
        static const struct cmsg_hop route[] = {
                {tx_gc_advance, NULL}
        };
        struct relay *relay = (struct relay *)trigger->data;
        struct relay_gc_msg *m = (struct relay_gc_msg *)malloc(sizeof(*m));
        if (m == NULL) {
                say_warn("failed to allocate relay gc message");
                return;
        }
        cmsg_init(&m->msg, route);
        m->relay = relay;
        vclock_copy(&m->vclock, &relay->r->vclock);
        /*
         * Do not invoke garbage collection until the replica
         * confirms that it has received data stored in the
         * sent xlog.
         */
        stailq_add_tail_entry(&relay->pending_gc, m, in_pending);
}

/**
 * Invoke pending garbage collection requests.
 *
 * This function schedules the most recent gc message whose
 * vclock is less than or equal to the given one. Older
 * messages are discarded as their job will be done by the
 * scheduled message anyway.
 */
static inline void
relay_schedule_pending_gc(struct relay *relay, const struct vclock *vclock)
{
        struct relay_gc_msg *curr, *next, *gc_msg = NULL;
        stailq_foreach_entry_safe(curr, next, &relay->pending_gc, in_pending) {
                if (vclock_sum(&curr->vclock) > vclock_sum(vclock))
                        break;
                stailq_shift(&relay->pending_gc);
                free(gc_msg);
                gc_msg = curr;
        }
        if (gc_msg != NULL)
                cpipe_push(&relay->tx_pipe, &gc_msg->msg);
}

static void
relay_process_wal_event(struct wal_watcher_msg *msg)
{
        assert((msg->events & (WAL_EVENT_WRITE | WAL_EVENT_ROTATE)) != 0);

        struct relay *relay = container_of(msg->watcher, struct relay,
                                           wal_watcher);
        if (relay->state != RELAY_FOLLOW) {
                /*
                 * Do not try to send anything to the replica
                 * if it already closed its socket.
                 */
                return;
        }
        try {
                recover_remaining_wals(relay->r, &relay->stream, NULL,
                                       (msg->events & WAL_EVENT_ROTATE) != 0);
        } catch (Exception *e) {
                e->log();
                diag_move(diag_get(), &relay->diag);
                fiber_cancel(fiber());
        }
}

/*
 * Relay reader fiber function.
 * Read xrow encoded vclocks sent by the replica.
 */
int
relay_reader_f(va_list ap)
{
        struct relay *relay = va_arg(ap, struct relay *);
        struct fiber *relay_f = va_arg(ap, struct fiber *);

        struct ibuf ibuf;
        struct ev_io io;
        coio_create(&io, relay->io.fd);
        ibuf_create(&ibuf, &cord()->slabc, 1024);
        try {
                while (!fiber_is_cancelled()) {
                        struct xrow_header xrow;
                        coio_read_xrow_timeout_xc(&io, &ibuf, &xrow,
                                        replication_disconnect_timeout());
                        /* vclock is followed while decoding, zeroing it. */
                        vclock_create(&relay->recv_vclock);
                        xrow_decode_vclock_xc(&xrow, &relay->recv_vclock);
                        fiber_cond_signal(&relay->reader_cond);
                }
        } catch (Exception *e) {
                if (diag_is_empty(&relay->diag)) {
                        /* Don't override existing error. */
                        diag_move(diag_get(), &relay->diag);
                        fiber_cancel(relay_f);
                } else if (!fiber_is_cancelled()) {
                        /*
                         * There is an relay error and this fiber
                         * fiber has another, log it.
                         */
                        e->log();
                }
        }
        ibuf_destroy(&ibuf);
        return 0;
}

/**
 * Send a heartbeat message over a connected relay.
 */
static void
relay_send_heartbeat(struct relay *relay)
{
        struct xrow_header row;
        xrow_encode_timestamp(&row, instance_id, ev_now(loop()));
        try {
                relay_send(relay, &row);
        } catch (Exception *e) {
                e->log();
        }
}

/**
 * A libev callback invoked when a relay client socket is ready
 * for read. This currently only happens when the client closes
 * its socket, and we get an EOF.
 */
static int
relay_subscribe_f(va_list ap)
{
        struct relay *relay = va_arg(ap, struct relay *);
        struct recovery *r = relay->r;

        coio_enable();
        cbus_endpoint_create(&relay->endpoint, cord_name(cord()),
                             fiber_schedule_cb, fiber());
        cbus_pair("tx", cord_name(cord()), &relay->tx_pipe, &relay->relay_pipe,
                  NULL, NULL, cbus_process);
        /* Setup garbage collection trigger. */
        struct trigger on_close_log = {
                RLIST_LINK_INITIALIZER, relay_on_close_log_f, relay, NULL
        };
        trigger_add(&r->on_close_log, &on_close_log);
        wal_set_watcher(&relay->wal_watcher, cord_name(cord()),
                        relay_process_wal_event, cbus_process,
                        WAL_EVENT_WRITE | WAL_EVENT_ROTATE);

        relay_set_cord_name(relay->io.fd);

        char name[FIBER_NAME_MAX];
        snprintf(name, sizeof(name), "%s:%s", fiber()->name, "reader");
        struct fiber *reader = fiber_new_xc(name, relay_reader_f);
        fiber_set_joinable(reader, true);
        fiber_start(reader, relay, fiber());

        /*
         * If the replica happens to be up to date on subscribe,
         * don't wait for timeout to happen - send a heartbeat
         * message right away to update the replication lag as
         * soon as possible.
         */
        relay_send_heartbeat(relay);

        while (!fiber_is_cancelled()) {
                double timeout = replication_timeout;
                struct errinj *inj = errinj(ERRINJ_RELAY_REPORT_INTERVAL,
                                            ERRINJ_DOUBLE);
                if (inj != NULL && inj->dparam != 0)
                        timeout = inj->dparam;

                fiber_cond_wait_deadline(&relay->reader_cond,
                                         relay->last_row_tm + timeout);

                /*
                 * The fiber can be woken by IO cancel, by a timeout of
                 * status messaging or by an acknowledge to status message.
                 * Handle cbus messages first.
                 */
                cbus_process(&relay->endpoint);
                /* Check for a heartbeat timeout. */
                if (ev_monotonic_now(loop()) - relay->last_row_tm > timeout)
                        relay_send_heartbeat(relay);
                /*
                 * Check that the vclock has been updated and the previous
                 * status message is delivered
                 */
                if (relay->status_msg.msg.route != NULL)
                        continue;
                struct vclock *send_vclock;
                if (relay->version_id < version_id(1, 7, 4))
                        send_vclock = &r->vclock;
                else
                        send_vclock = &relay->recv_vclock;
                if (vclock_sum(&relay->status_msg.vclock) ==
                    vclock_sum(send_vclock))
                        continue;
                static const struct cmsg_hop route[] = {
                        {tx_status_update, NULL}
                };
                cmsg_init(&relay->status_msg.msg, route);
                vclock_copy(&relay->status_msg.vclock, send_vclock);
                relay->status_msg.relay = relay;
                cpipe_push(&relay->tx_pipe, &relay->status_msg.msg);
                /* Collect xlog files received by the replica. */
                relay_schedule_pending_gc(relay, send_vclock);
        }

        say_crit("exiting the relay loop");
        trigger_clear(&on_close_log);
        wal_clear_watcher(&relay->wal_watcher, cbus_process);
        if (!fiber_is_dead(reader))
                fiber_cancel(reader);
        fiber_join(reader);
        cbus_unpair(&relay->tx_pipe, &relay->relay_pipe,
                    NULL, NULL, cbus_process);
        cbus_endpoint_destroy(&relay->endpoint, cbus_process);
        if (!diag_is_empty(&relay->diag)) {
                /* An error has occurred while reading ACKs of xlog. */
                diag_move(&relay->diag, diag_get());
                /* Reference the diag in the status. */
                diag_add_error(&relay->diag, diag_last_error(diag_get()));
        }
        struct errinj *inj = errinj(ERRINJ_RELAY_EXIT_DELAY, ERRINJ_DOUBLE);
        if (inj != NULL && inj->dparam > 0)
                fiber_sleep(inj->dparam);

        return diag_is_empty(diag_get()) ? 0: -1;
}

/** Replication acceptor fiber handler. */
void
relay_subscribe(struct replica *replica, int fd, uint64_t sync,
                struct vclock *replica_clock, uint32_t replica_version_id)
{
        assert(replica->id != REPLICA_ID_NIL);
        struct relay *relay = replica->relay;
        assert(relay->state != RELAY_FOLLOW);
        /*
         * Register the replica with the garbage collector
         * unless it has already been registered by initial
         * join.
         */
        if (replica->gc == NULL) {
                replica->gc = gc_consumer_register(replica_clock, "replica %s",
                                                   tt_uuid_str(&replica->uuid));
                if (replica->gc == NULL)
                        diag_raise();
        }

        relay_start(relay, fd, sync, relay_send_row);
        vclock_copy(&relay->local_vclock_at_subscribe, &replicaset.vclock);
        relay->r = recovery_new(cfg_gets("wal_dir"),
                                cfg_geti("force_recovery"),
                                replica_clock);
        vclock_copy(&relay->tx.vclock, replica_clock);
        relay->version_id = replica_version_id;

        int rc = cord_costart(&relay->cord, tt_sprintf("relay_%p", relay),
                              relay_subscribe_f, relay);
        if (rc == 0)
                rc = cord_cojoin(&relay->cord);

        relay_stop(relay);
        replica_on_relay_stop(replica);

        if (rc != 0)
                diag_raise();
}

static void
relay_send(struct relay *relay, struct xrow_header *packet)
{
        packet->sync = relay->sync;
        relay->last_row_tm = ev_monotonic_now(loop());
        coio_write_xrow(&relay->io, packet);
        fiber_gc();

        struct errinj *inj = errinj(ERRINJ_RELAY_TIMEOUT, ERRINJ_DOUBLE);
        if (inj != NULL && inj->dparam > 0)
                fiber_sleep(inj->dparam);
}

static void
relay_send_initial_join_row(struct xstream *stream, struct xrow_header *row)
{
        struct relay *relay = container_of(stream, struct relay, stream);
        /*
         * Ignore replica local requests as we don't need to promote
         * vclock while sending a snapshot.
         */
        if (row->group_id != GROUP_LOCAL)
                relay_send(relay, row);
}

/** Send a single row to the client. */
static void
relay_send_row(struct xstream *stream, struct xrow_header *packet)
{
        struct relay *relay = container_of(stream, struct relay, stream);
        assert(iproto_type_is_dml(packet->type));
        /*
         * Transform replica local requests to IPROTO_NOP so as to
         * promote vclock on the replica without actually modifying
         * any data.
         */
        if (packet->group_id == GROUP_LOCAL) {
                packet->type = IPROTO_NOP;
                packet->group_id = GROUP_DEFAULT;
                packet->bodycnt = 0;
        }
        /*
         * We're feeding a WAL, thus responding to FINAL JOIN or SUBSCRIBE
         * request. If this is FINAL JOIN (i.e. relay->replica is NULL),
         * we must relay all rows, even those originating from the replica
         * itself (there may be such rows if this is rebootstrap). If this
         * SUBSCRIBE, only send a row if it is not from the same replica
         * (i.e. don't send replica's own rows back) or if this row is
         * missing on the other side (i.e. in case of sudden power-loss,
         * data was not written to WAL, so remote master can't recover
         * it). In the latter case packet's LSN is less than or equal to
         * local master's LSN at the moment it received 'SUBSCRIBE' request.
         */
        if (relay->replica == NULL ||
            packet->replica_id != relay->replica->id ||
            packet->lsn <= vclock_get(&relay->local_vclock_at_subscribe,
                                      packet->replica_id)) {
                struct errinj *inj = errinj(ERRINJ_RELAY_BREAK_LSN,
                                            ERRINJ_INT);
                if (inj != NULL && packet->lsn == inj->iparam) {
                        packet->lsn = inj->iparam - 1;
                        say_warn("injected broken lsn: %lld",
                                 (long long) packet->lsn);
                }
                relay_send(relay, packet);
        }
}

tarantool / tarantool / 14947

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous