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%2FTransmitQueue.java;h=24264eeedff77bca598e58d4d3f4f4a6ac996c34;hp=9ab80d0d0085df1ef612e48606079b4eae413ea0;hb=dafc95d149bc62f101de37e94b9b5e3526d4e87b;hpb=e1c283de301355cb8fa3f7d4fa28a6dd0af501eb diff --git a/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/TransmitQueue.java b/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/TransmitQueue.java index 9ab80d0d00..24264eeedf 100644 --- a/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/TransmitQueue.java +++ b/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/TransmitQueue.java @@ -8,11 +8,13 @@ package org.opendaylight.controller.cluster.access.client; import akka.actor.ActorRef; +import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Preconditions; import com.google.common.base.Verify; -import com.google.common.collect.Iterables; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.util.ArrayDeque; +import java.util.Collection; +import java.util.Deque; import java.util.Iterator; import java.util.Optional; import java.util.Queue; @@ -52,10 +54,16 @@ import org.slf4j.LoggerFactory; @NotThreadSafe abstract class TransmitQueue { static final class Halted extends TransmitQueue { + // For ConnectingClientConnection. Halted(final int targetDepth) { super(targetDepth); } + // For ReconnectingClientConnection. + Halted(final TransmitQueue oldQueue, final long now) { + super(oldQueue, now); + } + @Override int canTransmitCount(final int inflightSize) { return 0; @@ -71,8 +79,9 @@ abstract class TransmitQueue { private final BackendInfo backend; private long nextTxSequence; - Transmitting(final int targetDepth, final BackendInfo backend) { - super(targetDepth); + // For ConnectedClientConnection. + Transmitting(final TransmitQueue oldQueue, final int targetDepth, final BackendInfo backend, final long now) { + super(oldQueue, targetDepth, now); this.backend = Preconditions.checkNotNull(backend); } @@ -95,17 +104,53 @@ abstract class TransmitQueue { private static final Logger LOG = LoggerFactory.getLogger(TransmitQueue.class); - private final ArrayDeque inflight = new ArrayDeque<>(); - private final ArrayDeque pending = new ArrayDeque<>(); - private final ProgressTracker tracker; + private final Deque inflight = new ArrayDeque<>(); + private final Deque pending = new ArrayDeque<>(); + private final AveragingProgressTracker tracker; // Cannot be just ProgressTracker as we are inheriting limits. private ReconnectForwarder successor; + /** + * Construct initial transmitting queue. + */ TransmitQueue(final int targetDepth) { tracker = new AveragingProgressTracker(targetDepth); } - final Iterable asIterable() { - return Iterables.concat(inflight, pending); + /** + * Construct new transmitting queue while inheriting timing data from the previous transmit queue instance. + */ + TransmitQueue(final TransmitQueue oldQueue, final int targetDepth, final long now) { + tracker = new AveragingProgressTracker(oldQueue.tracker, targetDepth, now); + } + + /** + * Construct new transmitting queue while inheriting timing and size data from the previous transmit queue instance. + */ + TransmitQueue(final TransmitQueue oldQueue, final long now) { + tracker = new AveragingProgressTracker(oldQueue.tracker, now); + } + + /** + * Cancel the accumulated sum of delays as we expect the new backend to work now. + */ + void cancelDebt(final long now) { + tracker.cancelDebt(now); + } + + /** + * Drain the contents of the connection into a list. This will leave the queue empty and allow further entries + * to be added to it during replay. When we set the successor all entries enqueued between when this methods + * returns and the successor is set will be replayed to the successor. + * + * @return Collection of entries present in the queue. + */ + final Collection drain() { + final Collection ret = new ArrayDeque<>(inflight.size() + pending.size()); + ret.addAll(inflight); + ret.addAll(pending); + inflight.clear(); + pending.clear(); + return ret; } final long ticksStalling(final long now) { @@ -133,19 +178,38 @@ abstract class TransmitQueue { tracker.closeTask(now, entry.getEnqueuedTicks(), entry.getTxTicks(), envelope.getExecutionTimeNanos()); // We have freed up a slot, try to transmit something - int toSend = canTransmitCount(inflight.size()); - while (toSend > 0) { + tryTransmit(now); + + return Optional.of(entry); + } + + final void tryTransmit(final long now) { + final int toSend = canTransmitCount(inflight.size()); + if (toSend > 0 && !pending.isEmpty()) { + transmitEntries(toSend, now); + } + } + + private void transmitEntries(final int maxTransmit, final long now) { + for (int i = 0; i < maxTransmit; ++i) { final ConnectionEntry e = pending.poll(); if (e == null) { - break; + LOG.debug("Queue {} transmitted {} requests", this, i); + return; } - LOG.debug("Transmitting entry {}", e); - transmit(e, now); - toSend--; + transmitEntry(e, now); } - return Optional.of(entry); + LOG.debug("Queue {} transmitted {} requests", this, maxTransmit); + } + + private void transmitEntry(final ConnectionEntry entry, final long now) { + LOG.debug("Queue {} transmitting entry {}", this, entry); + // We are not thread-safe and are supposed to be externally-guarded, + // hence send-before-record should be fine. + // This needs to be revisited if the external guards are lowered. + inflight.addLast(transmit(entry, now)); } /** @@ -155,6 +219,7 @@ abstract class TransmitQueue { */ final long enqueue(final ConnectionEntry entry, final long now) { if (successor != null) { + // This call will pay the enqueuing price, hence the caller does not have to successor.forwardEntry(entry, now); return 0; } @@ -164,16 +229,25 @@ abstract class TransmitQueue { // Reserve an entry before we do anything that can fail final long delay = tracker.openTask(now); - if (canTransmitCount(inflight.size()) <= 0) { + + /* + * This is defensive to make sure we do not do the wrong thing here and reorder messages if we ever happen + * to have available send slots and non-empty pending queue. + */ + final int toSend = canTransmitCount(inflight.size()); + if (toSend <= 0) { LOG.trace("Queue is at capacity, delayed sending of request {}", entry.getRequest()); - pending.add(entry); - } else { - // We are not thread-safe and are supposed to be externally-guarded, - // hence send-before-record should be fine. - // This needs to be revisited if the external guards are lowered. - inflight.offer(transmit(entry, now)); - LOG.debug("Sent request {} on queue {}", entry.getRequest(), this); + pending.addLast(entry); + return delay; + } + + if (pending.isEmpty()) { + transmitEntry(entry, now); + return delay; } + + pending.addLast(entry); + transmitEntries(toSend, now); return delay; } @@ -203,23 +277,53 @@ abstract class TransmitQueue { } final void setForwarder(final ReconnectForwarder forwarder, final long now) { - Verify.verify(successor == null, "Successor {} already set on connection {}", successor, this); + Verify.verify(successor == null, "Successor %s already set on connection %s", successor, this); successor = Preconditions.checkNotNull(forwarder); LOG.debug("Connection {} superseded by {}, splicing queue", this, successor); + /* + * We need to account for entries which have been added between the time drain() was called and this method + * is invoked. Since the old connection is visible during replay and some entries may have completed on the + * replay thread, there was an avenue for this to happen. + */ + int count = 0; ConnectionEntry entry = inflight.poll(); while (entry != null) { - successor.forwardEntry(entry, now); + successor.replayEntry(entry, now); entry = inflight.poll(); + count++; } entry = pending.poll(); while (entry != null) { - successor.forwardEntry(entry, now); + successor.replayEntry(entry, now); entry = pending.poll(); + count++; + } + + LOG.debug("Connection {} queue spliced {} messages", this, count); + } + + final void remove(final long now) { + final TransmittedConnectionEntry txe = inflight.poll(); + if (txe == null) { + final ConnectionEntry entry = pending.pop(); + tracker.closeTask(now, entry.getEnqueuedTicks(), 0, 0); + } else { + tracker.closeTask(now, txe.getEnqueuedTicks(), txe.getTxTicks(), 0); } } + @VisibleForTesting + Deque getInflight() { + return inflight; + } + + @VisibleForTesting + Deque getPending() { + return pending; + } + /* * We are using tri-state return here to indicate one of three conditions: * - if a matching entry is found, return an Optional containing it @@ -282,5 +386,4 @@ abstract class TransmitQueue { } queue.clear(); } - }