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=f190e14b61e01d4f2a48c78e1a6761fd84028e78;hp=361027af1de299fab960c487c32b0c09e51bbdb1;hb=HEAD;hpb=62cddd88e42e8f3c6a92bbf42c97b0d6806f44ae 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 361027af1d..f34760ec03 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 @@ -15,7 +15,9 @@ import com.google.common.base.MoreObjects; import com.google.common.base.MoreObjects.ToStringHelper; 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; @@ -74,11 +76,11 @@ public abstract class AbstractClientConnection { private static final long MAX_DELAY_NANOS = TimeUnit.SECONDS.toNanos(MAX_DELAY_SECONDS); private final Lock lock = new ReentrantLock(); - private final ClientActorContext context; - @GuardedBy("lock") - private final TransmitQueue queue; + private final @NonNull ClientActorContext context; private final @NonNull Long cookie; private final String backendName; + @GuardedBy("lock") + private final TransmitQueue queue; @GuardedBy("lock") private boolean haveTimer; @@ -93,12 +95,12 @@ public abstract class AbstractClientConnection { // Private constructor to avoid code duplication. private AbstractClientConnection(final AbstractClientConnection oldConn, final TransmitQueue newQueue, final String backendName) { - this.context = requireNonNull(oldConn.context); - this.cookie = requireNonNull(oldConn.cookie); + context = oldConn.context; + cookie = oldConn.cookie; this.backendName = requireNonNull(backendName); - this.queue = requireNonNull(newQueue); + queue = requireNonNull(newQueue); // Will be updated in finishReplay if needed. - this.lastReceivedTicks = oldConn.lastReceivedTicks; + lastReceivedTicks = oldConn.lastReceivedTicks; } // This constructor is only to be called by ConnectingClientConnection constructor. @@ -108,8 +110,8 @@ public abstract class AbstractClientConnection { this.context = requireNonNull(context); this.cookie = requireNonNull(cookie); this.backendName = requireNonNull(backendName); - this.queue = new TransmitQueue.Halted(queueDepth); - this.lastReceivedTicks = currentTime(); + queue = new TransmitQueue.Halted(queueDepth); + lastReceivedTicks = currentTime(); } // This constructor is only to be called (indirectly) by ReconnectingClientConnection constructor. @@ -126,7 +128,7 @@ public abstract class AbstractClientConnection { requireNonNull(oldConn.context).messageSlicer()), newBackend.getName()); } - public final ClientActorContext context() { + public final @NonNull ClientActorContext context() { return context; } @@ -134,7 +136,7 @@ public abstract class AbstractClientConnection { return cookie; } - public final ActorRef localActor() { + public final @NonNull ActorRef localActor() { return context.self(); } @@ -163,7 +165,7 @@ public abstract class AbstractClientConnection { * *

* Note that unlike {@link #sendRequest(Request, Consumer)}, this method does not exert backpressure, hence it - * should never be called from an application thread. + * should never be called from an application thread and serves mostly for moving requests between queues. * * @param request Request to send * @param callback Callback to invoke @@ -316,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(); @@ -328,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.orElseThrow()); + } 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); @@ -384,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); @@ -402,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++; @@ -417,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) { @@ -435,18 +440,31 @@ public abstract class AbstractClientConnection { } final void poison(final RequestException cause) { + final List entries; + lock.lock(); try { - lockedPoison(cause); + entries = lockedPoison(cause); } finally { lock.unlock(); } + + poison(entries, 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 void lockedPoison(final RequestException cause) { + private List lockedPoison(final RequestException cause) { poisoned = enrichPoison(cause); - queue.poison(cause); + return queue.poison(); } RequestException enrichPoison(final RequestException ex) { @@ -471,7 +489,7 @@ public abstract class AbstractClientConnection { } if (maybeEntry.isPresent()) { - final TransmittedConnectionEntry entry = maybeEntry.get(); + final TransmittedConnectionEntry entry = maybeEntry.orElseThrow(); LOG.debug("Completing {} with {}", entry, envelope); entry.complete(envelope.getMessage()); }