import com.google.common.base.Verify;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.ArrayDeque;
+import java.util.Iterator;
+import java.util.Map.Entry;
import java.util.Optional;
import java.util.Queue;
import java.util.concurrent.TimeUnit;
import javax.annotation.concurrent.GuardedBy;
import javax.annotation.concurrent.NotThreadSafe;
import org.opendaylight.controller.cluster.access.concepts.Request;
+import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
import org.opendaylight.controller.cluster.access.concepts.RequestException;
import org.opendaylight.controller.cluster.access.concepts.Response;
import org.opendaylight.controller.cluster.access.concepts.ResponseEnvelope;
@VisibleForTesting
static final long REQUEST_TIMEOUT_NANOS = TimeUnit.SECONDS.toNanos(30);
+ private final Queue<TransmittedConnectionEntry> inflight;
private final Queue<ConnectionEntry> pending;
+
private final ClientActorContext context;
private final Long cookie;
private long lastProgress;
private AbstractClientConnection(final ClientActorContext context, final Long cookie,
- final Queue<ConnectionEntry> pending) {
+ final Queue<TransmittedConnectionEntry> inflight, final Queue<ConnectionEntry> pending) {
this.context = Preconditions.checkNotNull(context);
this.cookie = Preconditions.checkNotNull(cookie);
+ this.inflight = Preconditions.checkNotNull(inflight);
this.pending = Preconditions.checkNotNull(pending);
this.lastProgress = readTime();
}
// Do not allow subclassing outside of this package
AbstractClientConnection(final ClientActorContext context, final Long cookie) {
- this(context, cookie, new ArrayDeque<>(1));
+ this(context, cookie, new ArrayDeque<>(), new ArrayDeque<>(1));
}
// Do not allow subclassing outside of this package
AbstractClientConnection(final AbstractClientConnection<T> oldConnection) {
- this(oldConnection.context, oldConnection.cookie, oldConnection.pending);
+ this(oldConnection.context, oldConnection.cookie, oldConnection.inflight, oldConnection.pending);
}
public final ClientActorContext context() {
return context.self();
}
- final long readTime() {
- return context.ticker().read();
- }
-
- final Queue<ConnectionEntry> pending() {
- return pending;
- }
-
/**
* Send a request to the backend and invoke a specified callback when it finishes. This method is safe to invoke
* from any thread.
public abstract Optional<T> getBackendInfo();
+ abstract ClientActorBehavior<T> reconnectConnection(ClientActorBehavior<T> current);
+
+ abstract int remoteMaxMessages();
+
+ abstract Entry<ActorRef, RequestEnvelope> prepareForTransmit(Request<?, ?> req);
+
@GuardedBy("this")
- void spliceToSuccessor(final ReconnectForwarder successor) {
- ConnectionEntry entry = pending.poll();
+ final void spliceToSuccessor(final ReconnectForwarder successor) {
+ ConnectionEntry entry = inflight.poll();
+ while (entry != null) {
+ successor.forwardEntry(entry);
+ entry = inflight.poll();
+ }
+
+ entry = pending.poll();
while (entry != null) {
successor.forwardEntry(entry);
entry = pending.poll();
}
}
- final ConnectionEntry dequeEntry() {
- lastProgress = readTime();
- return pending.poll();
+ private long readTime() {
+ return context.ticker().read();
+ }
+
+ private void transmit(final ConnectionEntry entry) {
+ final Entry<ActorRef, RequestEnvelope> tuple = prepareForTransmit(entry.getRequest());
+ final RequestEnvelope req = tuple.getValue();
+
+ // We need to enqueue the request before we send it to the actor, as we may be executing on a different thread
+ // than the client actor thread, in which case the round-trip could be made faster than we can enqueue --
+ // in which case the receive routine would not find the entry.
+ final TransmittedConnectionEntry txEntry = new TransmittedConnectionEntry(entry, req.getSessionId(),
+ req.getTxSequence(), readTime());
+ inflight.add(txEntry);
+
+ final ActorRef actor = tuple.getKey();
+ LOG.trace("Transmitting request {} as {} to {}", entry.getRequest(), req, actor);
+ actor.tell(req, ActorRef.noSender());
}
- void enqueueEntry(final ConnectionEntry entry) {
- pending.add(entry);
+ final void enqueueEntry(final ConnectionEntry entry) {
+ if (inflight.size() < remoteMaxMessages()) {
+ transmit(entry);
+ LOG.debug("Enqueued request {} to queue {}", entry.getRequest(), this);
+ } else {
+ LOG.debug("Queue is at capacity, delayed sending of request {}", entry.getRequest());
+ pending.add(entry);
+ }
}
/**
final ClientActorBehavior<T> runTimer(final ClientActorBehavior<T> current) {
final long now = readTime();
- if (!isEmpty()) {
+ if (!inflight.isEmpty() || !pending.isEmpty()) {
final long ticksSinceProgress = now - lastProgress;
if (ticksSinceProgress >= NO_PROGRESS_TIMEOUT_NANOS) {
LOG.error("Queue {} has not seen progress in {} seconds, failing all requests", this,
return current;
}
- boolean isEmpty() {
- return pending.isEmpty();
- }
-
/*
* We are using tri-state return here to indicate one of three conditions:
* - if there is no timeout to schedule, return Optional.empty()
*/
@SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL",
justification = "Returning null Optional is documented in the API contract.")
- final Optional<FiniteDuration> checkTimeout(final ConnectionEntry head, final long now) {
+ private Optional<FiniteDuration> checkTimeout(final ConnectionEntry head, final long now) {
if (head == null) {
return Optional.empty();
}
*/
@SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL",
justification = "Returning null Optional is documented in the API contract.")
- Optional<FiniteDuration> checkTimeout(final long now) {
- return checkTimeout(pending.peek(), now);
- }
-
- static void poisonQueue(final Queue<? extends ConnectionEntry> queue, final RequestException cause) {
- for (ConnectionEntry e : queue) {
- final Request<?, ?> request = e.getRequest();
- LOG.trace("Poisoning request {}", request, cause);
- e.complete(request.toRequestFailure(cause));
+ @VisibleForTesting
+ final Optional<FiniteDuration> checkTimeout(final long now) {
+ final Optional<FiniteDuration> xmit = checkTimeout(inflight.peek(), now);
+ if (xmit == null) {
+ return null;
}
- queue.clear();
+ final Optional<FiniteDuration> pend = checkTimeout(pending.peek(), now);
+ if (pend == null) {
+ return null;
+ }
+ if (!xmit.isPresent()) {
+ return pend;
+ }
+ if (!pend.isPresent()) {
+ return xmit;
+ }
+
+ return Optional.of(xmit.get().min(pend.get()));
}
- void poison(final RequestException cause) {
+ final void poison(final RequestException cause) {
poisoned = cause;
+
+ poisonQueue(inflight, cause);
poisonQueue(pending, cause);
}
return poisoned;
}
- abstract ClientActorBehavior<T> reconnectConnection(ClientActorBehavior<T> current);
+ final void receiveResponse(final ResponseEnvelope<?> envelope) {
+ Optional<TransmittedConnectionEntry> maybeEntry = findMatchingEntry(inflight, envelope);
+ if (maybeEntry == null) {
+ LOG.debug("Request for {} not found in inflight queue, checking pending queue", envelope);
+ maybeEntry = findMatchingEntry(pending, envelope);
+ }
- abstract void receiveResponse(final ResponseEnvelope<?> envelope);
+ if (maybeEntry == null || !maybeEntry.isPresent()) {
+ LOG.warn("No request matching {} found, ignoring response", envelope);
+ return;
+ }
+
+ final TransmittedConnectionEntry entry = maybeEntry.get();
+ LOG.debug("Completing {} with {}", entry, envelope);
+ entry.complete(envelope.getMessage());
+
+ // We have freed up a slot, try to transmit something
+ int toSend = remoteMaxMessages() - inflight.size();
+ while (toSend > 0) {
+ final ConnectionEntry e = pending.poll();
+ if (e == null) {
+ break;
+ }
+
+ LOG.debug("Transmitting entry {}", e);
+ transmit(e);
+ toSend--;
+ }
+
+ lastProgress = readTime();
+ }
+
+ private static void poisonQueue(final Queue<? extends ConnectionEntry> queue, final RequestException cause) {
+ for (ConnectionEntry e : queue) {
+ final Request<?, ?> request = e.getRequest();
+ LOG.trace("Poisoning request {}", request, cause);
+ e.complete(request.toRequestFailure(cause));
+ }
+ queue.clear();
+ }
+
+ /*
+ * We are using tri-state return here to indicate one of three conditions:
+ * - if a matching entry is found, return an Optional containing it
+ * - if a matching entry is not found, but it makes sense to keep looking at other queues, return null
+ * - if a conflicting entry is encountered, indicating we should ignore this request, return an empty Optional
+ */
+ @SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL",
+ justification = "Returning null Optional is documented in the API contract.")
+ private static Optional<TransmittedConnectionEntry> findMatchingEntry(final Queue<? extends ConnectionEntry> queue,
+ final ResponseEnvelope<?> envelope) {
+ // Try to find the request in a queue. Responses may legally come back in a different order, hence we need
+ // to use an iterator
+ final Iterator<? extends ConnectionEntry> it = queue.iterator();
+ while (it.hasNext()) {
+ final ConnectionEntry e = it.next();
+ final Request<?, ?> request = e.getRequest();
+ final Response<?, ?> response = envelope.getMessage();
+
+ // First check for matching target, or move to next entry
+ if (!request.getTarget().equals(response.getTarget())) {
+ continue;
+ }
+
+ // Sanity-check logical sequence, ignore any out-of-order messages
+ if (request.getSequence() != response.getSequence()) {
+ LOG.debug("Expecting sequence {}, ignoring response {}", request.getSequence(), envelope);
+ return Optional.empty();
+ }
+
+ // Check if the entry has (ever) been transmitted
+ if (!(e instanceof TransmittedConnectionEntry)) {
+ return Optional.empty();
+ }
+
+ final TransmittedConnectionEntry te = (TransmittedConnectionEntry) e;
+
+ // Now check session match
+ if (envelope.getSessionId() != te.getSessionId()) {
+ LOG.debug("Expecting session {}, ignoring response {}", te.getSessionId(), envelope);
+ return Optional.empty();
+ }
+ if (envelope.getTxSequence() != te.getTxSequence()) {
+ LOG.warn("Expecting txSequence {}, ignoring response {}", te.getTxSequence(), envelope);
+ return Optional.empty();
+ }
+
+ LOG.debug("Completing request {} with {}", request, envelope);
+ it.remove();
+ return Optional.of(te);
+ }
+
+ return null;
+ }
}
Code Review / controller.git / blobdiff