*/
package org.opendaylight.controller.cluster.access.client;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.annotations.Beta;
-import com.google.common.base.Preconditions;
import com.google.common.base.Stopwatch;
import com.google.common.base.Verify;
import java.util.Collection;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-import javax.annotation.concurrent.GuardedBy;
+import org.checkerframework.checker.lock.qual.Holding;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.controller.cluster.access.commands.NotLeaderException;
import org.opendaylight.controller.cluster.access.commands.OutOfSequenceEnvelopeException;
import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
import org.opendaylight.controller.cluster.io.FileBackedOutputStreamFactory;
import org.opendaylight.controller.cluster.messaging.MessageAssembler;
import org.opendaylight.yangtools.concepts.Identifiable;
-import org.opendaylight.yangtools.concepts.WritableIdentifier;
+import org.opendaylight.yangtools.concepts.Identifier;
+import org.opendaylight.yangtools.concepts.Registration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import scala.concurrent.duration.FiniteDuration;
* @param enqueuedEntries Previously-enqueued entries
* @return A {@link ReconnectForwarder} to handle any straggler messages which arrive after this method returns.
*/
- @Nonnull ReconnectForwarder finishReconnect(@Nonnull Collection<ConnectionEntry> enqueuedEntries);
+ @NonNull ReconnectForwarder finishReconnect(@NonNull Collection<ConnectionEntry> enqueuedEntries);
}
private static final Logger LOG = LoggerFactory.getLogger(ClientActorBehavior.class);
private final InversibleLock connectionsLock = new InversibleLock();
private final BackendInfoResolver<T> resolver;
private final MessageAssembler responseMessageAssembler;
+ private final Registration staleBackendInfoReg;
- protected ClientActorBehavior(@Nonnull final ClientActorContext context,
- @Nonnull final BackendInfoResolver<T> resolver) {
+ protected ClientActorBehavior(final @NonNull ClientActorContext context,
+ final @NonNull BackendInfoResolver<T> resolver) {
super(context);
- this.resolver = Preconditions.checkNotNull(resolver);
+ this.resolver = requireNonNull(resolver);
final ClientActorConfig config = context.config();
responseMessageAssembler = MessageAssembler.builder().logContext(persistenceId())
.fileBackedStreamFactory(new FileBackedOutputStreamFactory(config.getFileBackedStreamingThreshold(),
config.getTempFileDirectory()))
.assembledMessageCallback((message, sender) -> context.self().tell(message, sender)).build();
+
+ staleBackendInfoReg = resolver.notifyWhenBackendInfoIsStale(shard -> {
+ context().executeInActor(behavior -> {
+ LOG.debug("BackendInfo for shard {} is now stale", shard);
+ final AbstractClientConnection<T> conn = connections.get(shard);
+ if (conn instanceof ConnectedClientConnection) {
+ conn.reconnect(this, new BackendStaleException(shard));
+ }
+ return behavior;
+ });
+ });
}
@Override
- @Nonnull
public final ClientIdentifier getIdentifier() {
return context().getIdentifier();
}
@Override
public void close() {
+ super.close();
responseMessageAssembler.close();
+ staleBackendInfoReg.close();
}
/**
return this;
}
+ if (context().messageSlicer().handleMessage(command)) {
+ return this;
+ }
+
return onCommand(command);
}
- private static long extractCookie(final WritableIdentifier id) {
+ private static long extractCookie(final Identifier id) {
if (id instanceof TransactionIdentifier) {
return ((TransactionIdentifier) id).getHistoryId().getCookie();
} else if (id instanceof LocalHistoryIdentifier) {
} finally {
connectionsLock.unlockWrite(stamp);
}
+
+ context().messageSlicer().close();
}
/**
*
* @param cause Failure cause
*/
- protected abstract void haltClient(@Nonnull Throwable cause);
+ protected abstract void haltClient(@NonNull Throwable cause);
/**
* Override this method to handle any command which is not handled by the base behavior.
* @param command the command to process
* @return Next behavior to use, null if this actor should shut down.
*/
- @Nullable
- protected abstract ClientActorBehavior<T> onCommand(@Nonnull Object command);
+ protected abstract @Nullable ClientActorBehavior<T> onCommand(@NonNull Object command);
/**
* Override this method to provide a backend resolver instance.
*
* @return a backend resolver instance
*/
- protected final @Nonnull BackendInfoResolver<T> resolver() {
+ protected final @NonNull BackendInfoResolver<T> resolver() {
return resolver;
}
* @param newConn New connection
* @return ConnectionConnectCohort which will be used to complete the process of bringing the connection up.
*/
- @GuardedBy("connectionsLock")
- @Nonnull protected abstract ConnectionConnectCohort connectionUp(@Nonnull ConnectedClientConnection<T> newConn);
+ @Holding("connectionsLock")
+ protected abstract @NonNull ConnectionConnectCohort connectionUp(@NonNull ConnectedClientConnection<T> newConn);
- private void backendConnectFinished(final Long shard, final AbstractClientConnection<T> conn,
+ private void backendConnectFinished(final Long shard, final AbstractClientConnection<T> oldConn,
final T backend, final Throwable failure) {
if (failure != null) {
if (failure instanceof TimeoutException) {
- if (!conn.equals(connections.get(shard))) {
+ if (!oldConn.equals(connections.get(shard))) {
// AbstractClientConnection will remove itself when it decides there is no point in continuing,
// at which point we want to stop retrying
- LOG.info("{}: stopping resolution of shard {} on stale connection {}", persistenceId(), shard, conn,
- failure);
+ LOG.info("{}: stopping resolution of shard {} on stale connection {}", persistenceId(), shard,
+ oldConn, failure);
return;
}
LOG.debug("{}: timed out resolving shard {}, scheduling retry in {}", persistenceId(), shard,
RESOLVE_RETRY_DURATION, failure);
context().executeInActor(b -> {
- resolveConnection(shard, conn);
+ resolveConnection(shard, oldConn);
return b;
}, RESOLVE_RETRY_DURATION);
return;
cause = new RuntimeRequestException("Failed to resolve shard " + shard, failure);
}
- conn.poison(cause);
+ oldConn.poison(cause);
return;
}
final Stopwatch sw = Stopwatch.createStarted();
// Create a new connected connection
- final ConnectedClientConnection<T> newConn = new ConnectedClientConnection<>(conn.context(),
- conn.cookie(), backend);
- LOG.info("{}: resolving connection {} to {}", persistenceId(), conn, newConn);
+ final ConnectedClientConnection<T> newConn = new ConnectedClientConnection<>(oldConn, backend);
+ LOG.info("{}: resolving connection {} to {}", persistenceId(), oldConn, newConn);
// Start reconnecting without the old connection lock held
final ConnectionConnectCohort cohort = Verify.verifyNotNull(connectionUp(newConn));
// Lock the old connection and get a reference to its entries
- final Collection<ConnectionEntry> replayIterable = conn.startReplay();
+ final Collection<ConnectionEntry> replayIterable = oldConn.startReplay();
// Finish the connection attempt
final ReconnectForwarder forwarder = Verify.verifyNotNull(cohort.finishReconnect(replayIterable));
+ // Cancel sleep debt after entries were replayed, before new connection starts receiving.
+ newConn.cancelDebt();
+
// Install the forwarder, unlocking the old connection
- conn.finishReplay(forwarder);
+ oldConn.finishReplay(forwarder);
// Make sure new lookups pick up the new connection
- if (!connections.replace(shard, conn, newConn)) {
- final AbstractClientConnection<T> existing = connections.get(conn.cookie());
+ if (!connections.replace(shard, oldConn, newConn)) {
+ final AbstractClientConnection<T> existing = connections.get(oldConn.cookie());
LOG.warn("{}: old connection {} does not match existing {}, new connection {} in limbo",
- persistenceId(), conn, existing, newConn);
+ persistenceId(), oldConn, existing, newConn);
} else {
- LOG.info("{}: replaced connection {} with {} in {}", persistenceId(), conn, newConn, sw);
+ LOG.info("{}: replaced connection {} with {} in {}", persistenceId(), oldConn, newConn, sw);
}
} finally {
connectionsLock.unlockWrite(stamp);
}
} else {
LOG.info("{}: removed connection {}", persistenceId(), conn);
+ cancelSlicing(conn.cookie());
}
} finally {
connectionsLock.unlockWrite(stamp);
} else {
LOG.warn("{}: failed to replace connection {}, as it was not tracked", persistenceId(), conn);
}
+ } else {
+ cancelSlicing(oldConn.cookie());
}
} finally {
connectionsLock.unlockWrite(stamp);
}));
}
+ private void cancelSlicing(final Long cookie) {
+ context().messageSlicer().cancelSlicing(id -> {
+ try {
+ return cookie.equals(extractCookie(id));
+ } catch (IllegalArgumentException e) {
+ LOG.debug("extractCookie failed while cancelling slicing for cookie {}", cookie, e);
+ return false;
+ }
+ });
+ }
+
private ConnectingClientConnection<T> createConnection(final Long shard) {
- final ConnectingClientConnection<T> conn = new ConnectingClientConnection<>(context(), shard);
+ final ConnectingClientConnection<T> conn = new ConnectingClientConnection<>(context(), shard,
+ resolver().resolveCookieName(shard));
resolveConnection(shard, conn);
return conn;
}
return behavior;
}));
}
+
+ private static class BackendStaleException extends RequestException {
+ private static final long serialVersionUID = 1L;
+
+ BackendStaleException(final Long shard) {
+ super("Backend for shard " + shard + " is stale");
+ }
+
+ @Override
+ public boolean isRetriable() {
+ return false;
+ }
+ }
}
Code Review / controller.git / blobdiff