package org.opendaylight.controller.cluster.access.client;
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.Map;
import java.util.Optional;
-import java.util.concurrent.CompletionStage;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
-import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
+import javax.annotation.concurrent.GuardedBy;
+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.access.concepts.FailureEnvelope;
+import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
import org.opendaylight.controller.cluster.access.concepts.RequestException;
import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
+import org.opendaylight.controller.cluster.access.concepts.ResponseEnvelope;
import org.opendaylight.controller.cluster.access.concepts.RetiredGenerationException;
+import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
import org.opendaylight.controller.cluster.access.concepts.SuccessEnvelope;
+import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
+import org.opendaylight.controller.cluster.common.actor.Dispatchers.DispatcherType;
+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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import scala.concurrent.duration.FiniteDuration;
* @author Robert Varga
*/
@Beta
-public abstract class ClientActorBehavior extends RecoveredClientActorBehavior<ClientActorContext>
- implements Identifiable<ClientIdentifier> {
+public abstract class ClientActorBehavior<T extends BackendInfo> extends
+ RecoveredClientActorBehavior<ClientActorContext> implements Identifiable<ClientIdentifier> {
+ /**
+ * Connection reconnect cohort, driven by this class.
+ */
+ @FunctionalInterface
+ protected interface ConnectionConnectCohort {
+ /**
+ * Finish the connection by replaying previous messages onto the new connection.
+ *
+ * @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);
+ }
+
private static final Logger LOG = LoggerFactory.getLogger(ClientActorBehavior.class);
+ private static final FiniteDuration RESOLVE_RETRY_DURATION = FiniteDuration.apply(5, TimeUnit.SECONDS);
+
+ /**
+ * Map of connections to the backend. This map is concurrent to allow lookups, but given complex operations
+ * involved in connection transitions it is protected by a {@link InversibleLock}. Write-side of the lock is taken
+ * during connection transitions. Optimistic read-side of the lock is taken when new connections are introduced
+ * into the map.
+ *
+ * <p>
+ * The lock detects potential AB/BA deadlock scenarios and will force the reader side out by throwing
+ * a {@link InversibleLockException} -- which must be propagated up, releasing locks as it propagates. The initial
+ * entry point causing the the conflicting lookup must then call {@link InversibleLockException#awaitResolution()}
+ * before retrying the operation.
+ */
+ // TODO: it should be possible to move these two into ClientActorContext
+ private final Map<Long, AbstractClientConnection<T>> connections = new ConcurrentHashMap<>();
+ private final InversibleLock connectionsLock = new InversibleLock();
+ private final BackendInfoResolver<T> resolver;
+ private final MessageAssembler responseMessageAssembler;
- protected ClientActorBehavior(final @Nonnull ClientActorContext context) {
+ protected ClientActorBehavior(@Nonnull final ClientActorContext context,
+ @Nonnull final BackendInfoResolver<T> resolver) {
super(context);
+ this.resolver = Preconditions.checkNotNull(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();
}
@Override
- public final @Nonnull ClientIdentifier getIdentifier() {
+ @Nonnull
+ public final ClientIdentifier getIdentifier() {
return context().getIdentifier();
}
@Override
- final ClientActorBehavior onReceiveCommand(final Object command) {
- if (command instanceof InternalCommand) {
- return ((InternalCommand) command).execute(this);
- }
- if (command instanceof SuccessEnvelope) {
- return onRequestSuccess((SuccessEnvelope) command);
- }
- if (command instanceof FailureEnvelope) {
- return onRequestFailure((FailureEnvelope) command);
- }
+ public void close() {
+ responseMessageAssembler.close();
+ }
- return onCommand(command);
+ /**
+ * Get a connection to a shard.
+ *
+ * @param shard Shard cookie
+ * @return Connection to a shard
+ * @throws InversibleLockException if the shard is being reconnected
+ */
+ public final AbstractClientConnection<T> getConnection(final Long shard) {
+ while (true) {
+ final long stamp = connectionsLock.optimisticRead();
+ final AbstractClientConnection<T> conn = connections.computeIfAbsent(shard, this::createConnection);
+ if (connectionsLock.validate(stamp)) {
+ // No write-lock in-between, return success
+ return conn;
+ }
+ }
}
- private ClientActorBehavior onRequestSuccess(final SuccessEnvelope command) {
- return context().completeRequest(this, command);
+ private AbstractClientConnection<T> getConnection(final ResponseEnvelope<?> response) {
+ // Always called from actor context: no locking required
+ return connections.get(extractCookie(response.getMessage().getTarget()));
}
- private ClientActorBehavior onRequestFailure(final FailureEnvelope command) {
- final RequestFailure<?, ?> failure = command.getMessage();
- final RequestException cause = failure.getCause();
- if (cause instanceof RetiredGenerationException) {
- LOG.error("{}: current generation {} has been superseded", persistenceId(), getIdentifier(), cause);
- haltClient(cause);
- context().poison(cause);
- return null;
+ @SuppressWarnings("unchecked")
+ @Override
+ final ClientActorBehavior<T> onReceiveCommand(final Object command) {
+ if (command instanceof InternalCommand) {
+ return ((InternalCommand<T>) command).execute(this);
}
- if (failure.isHardFailure()) {
- return context().completeRequest(this, command);
+ if (command instanceof SuccessEnvelope) {
+ return onRequestSuccess((SuccessEnvelope) command);
}
- // TODO: add instanceof checks on cause to detect more problems
-
- LOG.warn("{}: Unhandled retriable failure {}, promoting to hard failure", persistenceId(), command);
- return context().completeRequest(this, command);
- }
-
- // This method is executing in the actor context, hence we can safely interact with the queue
- private ClientActorBehavior doSendRequest(final long sequence, final TransactionRequest<?> request,
- final RequestCallback callback) {
- // Get or allocate queue for the request
- final SequencedQueue queue = context().queueFor(request.getTarget().getHistoryId().getCookie());
-
- // Note this is a tri-state return and can be null
- final Optional<FiniteDuration> result = queue.enqueueRequest(sequence, request, callback);
- if (result == null) {
- // Happy path: we are done here
- return this;
+ if (command instanceof FailureEnvelope) {
+ return internalOnRequestFailure((FailureEnvelope) command);
}
- if (result.isPresent()) {
- // Less happy path: we need to schedule a timer
- scheduleQueueTimeout(queue, result.get());
+ if (MessageAssembler.isHandledMessage(command)) {
+ context().dispatchers().getDispatcher(DispatcherType.Serialization).execute(
+ () -> responseMessageAssembler.handleMessage(command, context().self()));
return this;
}
- startResolve(queue, request.getTarget().getHistoryId().getCookie());
- return this;
+ return onCommand(command);
}
- // This method is executing in the actor context, hence we can safely interact with the queue
- private void startResolve(final SequencedQueue queue, final long cookie) {
- // Queue does not have backend information. Initiate resolution, which may actually be piggy-backing on to a
- // previous request to resolve.
- final CompletionStage<? extends BackendInfo> f = resolver().getBackendInfo(cookie);
-
- // This is the tricky part: depending on timing, the queue may have a stale request for resolution, which has
- // been invalidated or it may already have a reference to this resolution request. Let us give it a chance to
- // update and it will indicate if this resolution request is an update. If it is, we'll piggy-back on it and
- // run backend information update in the actor thread. If it is not, we do not need to do anything, as we will
- // bulk-process all requests.
- if (queue.expectProof(f)) {
- f.thenAccept(backend -> context().executeInActor(cb -> cb.finishResolve(queue, f, backend)));
+ private static long extractCookie(final WritableIdentifier id) {
+ if (id instanceof TransactionIdentifier) {
+ return ((TransactionIdentifier) id).getHistoryId().getCookie();
+ } else if (id instanceof LocalHistoryIdentifier) {
+ return ((LocalHistoryIdentifier) id).getCookie();
+ } else {
+ throw new IllegalArgumentException("Unhandled identifier " + id);
}
}
- // This method is executing in the actor context, hence we can safely interact with the queue
- private ClientActorBehavior finishResolve(final SequencedQueue queue,
- final CompletionStage<? extends BackendInfo> futureBackend, final BackendInfo backend) {
-
- final Optional<FiniteDuration> maybeTimeout = queue.setBackendInfo(futureBackend, backend);
- if (maybeTimeout.isPresent()) {
- scheduleQueueTimeout(queue, maybeTimeout.get());
+ private void onResponse(final ResponseEnvelope<?> response) {
+ final AbstractClientConnection<T> connection = getConnection(response);
+ if (connection != null) {
+ connection.receiveResponse(response);
+ } else {
+ LOG.info("{}: Ignoring unknown response {}", persistenceId(), response);
}
- return this;
}
- // This method is executing in the actor context, hence we can safely interact with the queue
- private void scheduleQueueTimeout(final SequencedQueue queue, final FiniteDuration timeout) {
- LOG.debug("{}: scheduling timeout in {}", persistenceId(), timeout);
- context().executeInActor(cb -> cb.queueTimeout(queue), timeout);
+ private ClientActorBehavior<T> onRequestSuccess(final SuccessEnvelope success) {
+ onResponse(success);
+ return this;
}
- // This method is executing in the actor context, hence we can safely interact with the queue
- private ClientActorBehavior queueTimeout(final SequencedQueue queue) {
- final boolean needBackend;
+ private ClientActorBehavior<T> onRequestFailure(final FailureEnvelope failure) {
+ onResponse(failure);
+ return this;
+ }
- try {
- needBackend = queue.runTimeout();
- } catch (NoProgressException e) {
- // Uh-oh, no progress. The queue has already killed itself, now we need to remove it
- context().removeQueue(queue);
- return this;
+ private ClientActorBehavior<T> internalOnRequestFailure(final FailureEnvelope command) {
+ final AbstractClientConnection<T> conn = getConnection(command);
+ if (conn != null) {
+ /*
+ * We are talking to multiple actors, which may be lagging behind our state significantly. This has
+ * the effect that we may be receiving responses from a previous connection after we have created a new
+ * one to a different actor.
+ *
+ * Since we are already replaying requests to the new actor, we want to ignore errors reported on the old
+ * connection -- for example NotLeaderException, which must not cause a new reconnect. Check the envelope's
+ * sessionId and if it does not match our current connection just ignore it.
+ */
+ final Optional<T> optBackend = conn.getBackendInfo();
+ if (optBackend.isPresent() && optBackend.get().getSessionId() != command.getSessionId()) {
+ LOG.debug("{}: Mismatched current connection {} and envelope {}, ignoring response", persistenceId(),
+ conn, command);
+ return this;
+ }
}
- if (needBackend) {
- startResolve(queue, queue.getCookie());
+ final RequestFailure<?, ?> failure = command.getMessage();
+ final RequestException cause = failure.getCause();
+ if (cause instanceof RetiredGenerationException) {
+ LOG.error("{}: current generation {} has been superseded", persistenceId(), getIdentifier(), cause);
+ haltClient(cause);
+ poison(cause);
+ return null;
+ }
+ if (cause instanceof NotLeaderException) {
+ if (conn instanceof ReconnectingClientConnection) {
+ // Already reconnecting, do not churn the logs
+ return this;
+ } else if (conn != null) {
+ LOG.info("{}: connection {} indicated no leadership, reconnecting it", persistenceId(), conn, cause);
+ return conn.reconnect(this, cause);
+ }
+ }
+ if (cause instanceof OutOfSequenceEnvelopeException) {
+ if (conn instanceof ReconnectingClientConnection) {
+ // Already reconnecting, do not churn the logs
+ return this;
+ } else if (conn != null) {
+ LOG.info("{}: connection {} indicated no sequencing mismatch on {} sequence {}, reconnecting it",
+ persistenceId(), conn, failure.getTarget(), failure.getSequence(), cause);
+ return conn.reconnect(this, cause);
+ }
}
- return this;
+ return onRequestFailure(command);
+ }
+
+ private void poison(final RequestException cause) {
+ final long stamp = connectionsLock.writeLock();
+ try {
+ for (AbstractClientConnection<T> q : connections.values()) {
+ q.poison(cause);
+ }
+
+ connections.clear();
+ } finally {
+ connectionsLock.unlockWrite(stamp);
+ }
}
/**
- * Halt And Catch Fire.
- *
- * Halt processing on this client. Implementations need to ensure they initiate state flush procedures. No attempt
- * to use this instance should be made after this method returns. Any such use may result in undefined behavior.
+ * Halt And Catch Fire. Halt processing on this client. Implementations need to ensure they initiate state flush
+ * procedures. No attempt to use this instance should be made after this method returns. Any such use may result
+ * in undefined behavior.
*
* @param cause Failure cause
*/
/**
* Override this method to handle any command which is not handled by the base behavior.
*
- * @param command
+ * @param command the command to process
* @return Next behavior to use, null if this actor should shut down.
*/
- protected abstract @Nullable ClientActorBehavior onCommand(@Nonnull Object command);
+ @Nullable
+ protected abstract ClientActorBehavior<T> onCommand(@Nonnull Object command);
/**
* Override this method to provide a backend resolver instance.
*
- * @return
+ * @return a backend resolver instance
*/
- protected abstract @Nonnull BackendInfoResolver<?> resolver();
+ protected final @Nonnull BackendInfoResolver<T> resolver() {
+ return resolver;
+ }
/**
- * Send a request to the backend and invoke a specified callback when it finishes. This method is safe to invoke
- * from any thread.
+ * Callback invoked when a new connection has been established. Implementations are expected perform preparatory
+ * tasks before the previous connection is frozen.
*
- * @param request Request to send
- * @param callback Callback to invoke
+ * @param newConn New connection
+ * @return ConnectionConnectCohort which will be used to complete the process of bringing the connection up.
*/
- public final void sendRequest(final long sequence, final TransactionRequest<?> request, final RequestCallback callback) {
- context().executeInActor(cb -> cb.doSendRequest(sequence, request, callback));
+ @GuardedBy("connectionsLock")
+ @Nonnull protected abstract ConnectionConnectCohort connectionUp(@Nonnull ConnectedClientConnection<T> newConn);
+
+ private void backendConnectFinished(final Long shard, final AbstractClientConnection<T> conn,
+ final T backend, final Throwable failure) {
+ if (failure != null) {
+ if (failure instanceof TimeoutException) {
+ if (!conn.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);
+ return;
+ }
+
+ LOG.debug("{}: timed out resolving shard {}, scheduling retry in {}", persistenceId(), shard,
+ RESOLVE_RETRY_DURATION, failure);
+ context().executeInActor(b -> {
+ resolveConnection(shard, conn);
+ return b;
+ }, RESOLVE_RETRY_DURATION);
+ return;
+ }
+
+ LOG.error("{}: failed to resolve shard {}", persistenceId(), shard, failure);
+ final RequestException cause;
+ if (failure instanceof RequestException) {
+ cause = (RequestException) failure;
+ } else {
+ cause = new RuntimeRequestException("Failed to resolve shard " + shard, failure);
+ }
+
+ conn.poison(cause);
+ return;
+ }
+
+ LOG.info("{}: resolved shard {} to {}", persistenceId(), shard, backend);
+ final long stamp = connectionsLock.writeLock();
+ try {
+ 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);
+
+ // 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();
+
+ // Finish the connection attempt
+ final ReconnectForwarder forwarder = Verify.verifyNotNull(cohort.finishReconnect(replayIterable));
+
+ // Install the forwarder, unlocking the old connection
+ conn.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());
+ LOG.warn("{}: old connection {} does not match existing {}, new connection {} in limbo",
+ persistenceId(), conn, existing, newConn);
+ } else {
+ LOG.info("{}: replaced connection {} with {} in {}", persistenceId(), conn, newConn, sw);
+ }
+ } finally {
+ connectionsLock.unlockWrite(stamp);
+ }
+ }
+
+ void removeConnection(final AbstractClientConnection<?> conn) {
+ final long stamp = connectionsLock.writeLock();
+ try {
+ if (!connections.remove(conn.cookie(), conn)) {
+ final AbstractClientConnection<T> existing = connections.get(conn.cookie());
+ if (existing != null) {
+ LOG.warn("{}: failed to remove connection {}, as it was superseded by {}", persistenceId(), conn,
+ existing);
+ } else {
+ LOG.warn("{}: failed to remove connection {}, as it was not tracked", persistenceId(), conn);
+ }
+ } else {
+ LOG.info("{}: removed connection {}", persistenceId(), conn);
+ }
+ } finally {
+ connectionsLock.unlockWrite(stamp);
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ void reconnectConnection(final ConnectedClientConnection<?> oldConn,
+ final ReconnectingClientConnection<?> newConn) {
+ final ReconnectingClientConnection<T> conn = (ReconnectingClientConnection<T>)newConn;
+ LOG.info("{}: connection {} reconnecting as {}", persistenceId(), oldConn, newConn);
+
+ final long stamp = connectionsLock.writeLock();
+ try {
+ final boolean replaced = connections.replace(oldConn.cookie(), (AbstractClientConnection<T>)oldConn, conn);
+ if (!replaced) {
+ final AbstractClientConnection<T> existing = connections.get(oldConn.cookie());
+ if (existing != null) {
+ LOG.warn("{}: failed to replace connection {}, as it was superseded by {}", persistenceId(), conn,
+ existing);
+ } else {
+ LOG.warn("{}: failed to replace connection {}, as it was not tracked", persistenceId(), conn);
+ }
+ }
+ } finally {
+ connectionsLock.unlockWrite(stamp);
+ }
+
+ final Long shard = oldConn.cookie();
+ LOG.info("{}: refreshing backend for shard {}", persistenceId(), shard);
+ resolver().refreshBackendInfo(shard, conn.getBackendInfo().get()).whenComplete(
+ (backend, failure) -> context().executeInActor(behavior -> {
+ backendConnectFinished(shard, conn, backend, failure);
+ return behavior;
+ }));
+ }
+
+ private ConnectingClientConnection<T> createConnection(final Long shard) {
+ final ConnectingClientConnection<T> conn = new ConnectingClientConnection<>(context(), shard);
+ resolveConnection(shard, conn);
+ return conn;
+ }
+
+ private void resolveConnection(final Long shard, final AbstractClientConnection<T> conn) {
+ LOG.debug("{}: resolving shard {} connection {}", persistenceId(), shard, conn);
+ resolver().getBackendInfo(shard).whenComplete((backend, failure) -> context().executeInActor(behavior -> {
+ backendConnectFinished(shard, conn, backend, failure);
+ return behavior;
+ }));
}
}
Code Review / controller.git / blobdiff