X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fcds-access-client%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Faccess%2Fclient%2FAbstractClientConnection.java;h=9c290df13da3f61da22f0f728eaa3b5a150f255f;hp=7375fe06d95f3986860755b5066eb47f4e6bff8d;hb=refs%2Fchanges%2F05%2F83005%2F5;hpb=a2d6d30d0a4bed7eb6d20dec5801bb21293fce1e diff --git a/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientConnection.java b/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientConnection.java index 7375fe06d9..9c290df13d 100644 --- a/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientConnection.java +++ b/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientConnection.java @@ -7,22 +7,25 @@ */ package org.opendaylight.controller.cluster.access.client; +import static java.util.Objects.requireNonNull; + import akka.actor.ActorRef; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.MoreObjects; import com.google.common.base.MoreObjects.ToStringHelper; -import com.google.common.base.Preconditions; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.util.Collection; +import java.util.List; import java.util.Optional; +import java.util.OptionalLong; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import java.util.concurrent.locks.Lock; import java.util.concurrent.locks.ReentrantLock; import java.util.function.Consumer; -import javax.annotation.Nonnull; -import javax.annotation.concurrent.GuardedBy; -import javax.annotation.concurrent.NotThreadSafe; +import org.checkerframework.checker.lock.qual.GuardedBy; +import org.checkerframework.checker.lock.qual.Holding; +import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.controller.cluster.access.concepts.Request; import org.opendaylight.controller.cluster.access.concepts.RequestException; import org.opendaylight.controller.cluster.access.concepts.Response; @@ -35,11 +38,10 @@ import scala.concurrent.duration.FiniteDuration; /** * Base class for a connection to the backend. Responsible to queueing and dispatch of requests toward the backend. * Can be in three conceptual states: Connecting, Connected and Reconnecting, which are represented by public final - * classes exposed from this package. + * classes exposed from this package. This class NOT thread-safe, not are its subclasses expected to be thread-safe. * * @author Robert Varga */ -@NotThreadSafe public abstract class AbstractClientConnection { private static final Logger LOG = LoggerFactory.getLogger(AbstractClientConnection.class); @@ -77,7 +79,8 @@ public abstract class AbstractClientConnection { private final ClientActorContext context; @GuardedBy("lock") private final TransmitQueue queue; - private final Long cookie; + private final @NonNull Long cookie; + private final String backendName; @GuardedBy("lock") private boolean haveTimer; @@ -90,19 +93,23 @@ public abstract class AbstractClientConnection { private volatile RequestException poisoned; // Private constructor to avoid code duplication. - private AbstractClientConnection(final AbstractClientConnection oldConn, final TransmitQueue newQueue) { - this.context = Preconditions.checkNotNull(oldConn.context); - this.cookie = Preconditions.checkNotNull(oldConn.cookie); - this.queue = Preconditions.checkNotNull(newQueue); + private AbstractClientConnection(final AbstractClientConnection oldConn, final TransmitQueue newQueue, + final String backendName) { + this.context = requireNonNull(oldConn.context); + this.cookie = requireNonNull(oldConn.cookie); + this.backendName = requireNonNull(backendName); + this.queue = requireNonNull(newQueue); // Will be updated in finishReplay if needed. this.lastReceivedTicks = oldConn.lastReceivedTicks; } // This constructor is only to be called by ConnectingClientConnection constructor. // Do not allow subclassing outside of this package - AbstractClientConnection(final ClientActorContext context, final Long cookie, final int queueDepth) { - this.context = Preconditions.checkNotNull(context); - this.cookie = Preconditions.checkNotNull(cookie); + AbstractClientConnection(final ClientActorContext context, final Long cookie, final String backendName, + final int queueDepth) { + this.context = requireNonNull(context); + this.cookie = requireNonNull(cookie); + this.backendName = requireNonNull(backendName); this.queue = new TransmitQueue.Halted(queueDepth); this.lastReceivedTicks = currentTime(); } @@ -110,21 +117,22 @@ public abstract class AbstractClientConnection { // This constructor is only to be called (indirectly) by ReconnectingClientConnection constructor. // Do not allow subclassing outside of this package AbstractClientConnection(final AbstractClientConnection oldConn) { - this(oldConn, new TransmitQueue.Halted(oldConn.queue, oldConn.currentTime())); + this(oldConn, new TransmitQueue.Halted(oldConn.queue, oldConn.currentTime()), oldConn.backendName); } // This constructor is only to be called (indirectly) by ConnectedClientConnection constructor. // Do not allow subclassing outside of this package - AbstractClientConnection(final AbstractClientConnection oldConn, final T newBackend, final int queueDepth) { + AbstractClientConnection(final AbstractClientConnection oldConn, final T newBackend, + final int queueDepth) { this(oldConn, new TransmitQueue.Transmitting(oldConn.queue, queueDepth, newBackend, oldConn.currentTime(), - Preconditions.checkNotNull(oldConn.context).messageSlicer())); + requireNonNull(oldConn.context).messageSlicer()), newBackend.getName()); } public final ClientActorContext context() { return context; } - public final @Nonnull Long cookie() { + public final @NonNull Long cookie() { return cookie; } @@ -191,7 +199,7 @@ public abstract class AbstractClientConnection { } } - @GuardedBy("lock") + @Holding("lock") private void commonEnqueue(final ConnectionEntry entry, final long now) { final RequestException maybePoison = poisoned; if (maybePoison != null) { @@ -216,7 +224,7 @@ public abstract class AbstractClientConnection { return queue.drain(); } - @GuardedBy("lock") + @Holding("lock") final void finishReplay(final ReconnectForwarder forwarder) { setForwarder(forwarder); @@ -236,12 +244,12 @@ public abstract class AbstractClientConnection { lock.unlock(); } - @GuardedBy("lock") + @Holding("lock") final void setForwarder(final ReconnectForwarder forwarder) { queue.setForwarder(forwarder, currentTime()); } - @GuardedBy("lock") + @Holding("lock") abstract ClientActorBehavior lockedReconnect(ClientActorBehavior current, RequestException runtimeRequestException); @@ -280,7 +288,7 @@ public abstract class AbstractClientConnection { * * @param delay Delay, in nanoseconds */ - @GuardedBy("lock") + @Holding("lock") private void scheduleTimer(final long delay) { if (haveTimer) { LOG.debug("{}: timer already scheduled on {}", context.persistenceId(), this); @@ -310,9 +318,10 @@ public abstract class AbstractClientConnection { */ @VisibleForTesting final ClientActorBehavior runTimer(final ClientActorBehavior current) { - final Optional delay; - lock.lock(); + + final List poisonEntries; + final NoProgressException poisonCause; try { haveTimer = false; final long now = currentTime(); @@ -322,41 +331,43 @@ public abstract class AbstractClientConnection { // The following line is only reliable when queue is not forwarding, but such state should not last long. // FIXME: BUG-8422: this may not be accurate w.r.t. replayed entries final long ticksSinceProgress = queue.ticksStalling(now); - if (ticksSinceProgress >= context.config().getNoProgressTimeout()) { - LOG.error("Queue {} has not seen progress in {} seconds, failing all requests", this, - TimeUnit.NANOSECONDS.toSeconds(ticksSinceProgress)); + if (ticksSinceProgress < context.config().getNoProgressTimeout()) { + // Requests are always scheduled in sequence, hence checking for timeout is relatively straightforward. + // Note we use also inquire about the delay, so we can re-schedule if needed, hence the unusual + // tri-state return convention. + final OptionalLong delay = lockedCheckTimeout(now); + if (delay == null) { + // We have timed out. There is no point in scheduling a timer + LOG.debug("{}: connection {} timed out", context.persistenceId(), this); + return lockedReconnect(current, new RuntimeRequestException("Backend connection timed out", + new TimeoutException())); + } - lockedPoison(new NoProgressException(ticksSinceProgress)); - current.removeConnection(this); - return current; - } + if (delay.isPresent()) { + // If there is new delay, schedule a timer + scheduleTimer(delay.getAsLong()); + } else { + LOG.debug("{}: not scheduling timeout on {}", context.persistenceId(), this); + } - // Requests are always scheduled in sequence, hence checking for timeout is relatively straightforward. - // Note we use also inquire about the delay, so we can re-schedule if needed, hence the unusual tri-state - // return convention. - delay = lockedCheckTimeout(now); - if (delay == null) { - // We have timed out. There is no point in scheduling a timer - LOG.debug("{}: connection {} timed out", context.persistenceId(), this); - return lockedReconnect(current, new RuntimeRequestException("Backend connection timed out", - new TimeoutException())); + return current; } - if (delay.isPresent()) { - // If there is new delay, schedule a timer - scheduleTimer(delay.get()); - } else { - LOG.debug("{}: not scheduling timeout on {}", context.persistenceId(), this); - } + LOG.error("Queue {} has not seen progress in {} seconds, failing all requests", this, + TimeUnit.NANOSECONDS.toSeconds(ticksSinceProgress)); + poisonCause = new NoProgressException(ticksSinceProgress); + poisonEntries = lockedPoison(poisonCause); + current.removeConnection(this); } finally { lock.unlock(); } + poison(poisonEntries, poisonCause); return current; } @VisibleForTesting - final Optional checkTimeout(final long now) { + final OptionalLong checkTimeout(final long now) { lock.lock(); try { return lockedCheckTimeout(now); @@ -378,10 +389,10 @@ public abstract class AbstractClientConnection { @SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL", justification = "Returning null Optional is documented in the API contract.") @GuardedBy("lock") - private Optional lockedCheckTimeout(final long now) { + private OptionalLong lockedCheckTimeout(final long now) { if (queue.isEmpty()) { LOG.debug("{}: connection {} is empty", context.persistenceId(), this); - return Optional.empty(); + return OptionalLong.empty(); } final long backendSilentTicks = backendSilentTicks(now); @@ -396,7 +407,7 @@ public abstract class AbstractClientConnection { final long beenOpen = now - head.getEnqueuedTicks(); final long requestTimeout = context.config().getRequestTimeout(); if (beenOpen < requestTimeout) { - return Optional.of(requestTimeout - beenOpen); + return OptionalLong.of(requestTimeout - beenOpen); } tasksTimedOut++; @@ -411,7 +422,7 @@ public abstract class AbstractClientConnection { queue.tryTransmit(now); } - return Optional.empty(); + return OptionalLong.empty(); } private void timeoutEntry(final ConnectionEntry entry, final long beenOpen) { @@ -422,24 +433,38 @@ public abstract class AbstractClientConnection { context.executeInActor(current -> { final double time = beenOpen * 1.0 / 1_000_000_000; entry.complete(entry.getRequest().toRequestFailure( - new RequestTimeoutException(entry.getRequest() + " timed out after " + time + " seconds"))); + new RequestTimeoutException(entry.getRequest() + " timed out after " + time + + " seconds. The backend for " + backendName + " is not available."))); return current; }); } final void poison(final RequestException cause) { + final List entries; + lock.lock(); try { - lockedPoison(cause); + entries = lockedPoison(cause); } finally { lock.unlock(); } + + poison(entries, cause); } - @GuardedBy("lock") - private void lockedPoison(final RequestException cause) { + // Do not hold any locks while calling this + private static void poison(final Collection entries, final RequestException cause) { + for (ConnectionEntry e : entries) { + final Request request = e.getRequest(); + LOG.trace("Poisoning request {}", request, cause); + e.complete(request.toRequestFailure(cause)); + } + } + + @Holding("lock") + private List lockedPoison(final RequestException cause) { poisoned = enrichPoison(cause); - queue.poison(cause); + return queue.poison(); } RequestException enrichPoison(final RequestException ex) {