*/
package org.opendaylight.controller.cluster.datastore;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.base.MoreObjects;
-import com.google.common.base.Preconditions;
+import com.google.common.base.MoreObjects.ToStringHelper;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
-import javax.annotation.Nullable;
-import javax.annotation.concurrent.NotThreadSafe;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.controller.cluster.access.commands.CreateLocalHistoryRequest;
import org.opendaylight.controller.cluster.access.commands.DeadHistoryException;
import org.opendaylight.controller.cluster.access.commands.DestroyLocalHistoryRequest;
/**
* Frontend state as observed by the shard leader. This class is responsible for tracking generations and sequencing
- * in the frontend/backend conversation.
+ * in the frontend/backend conversation. This class is NOT thread-safe.
*
* @author Robert Varga
*/
-@NotThreadSafe
-final class LeaderFrontendState implements Identifiable<ClientIdentifier> {
- private static final Logger LOG = LoggerFactory.getLogger(LeaderFrontendState.class);
-
- // Histories which have not been purged
- private final Map<LocalHistoryIdentifier, LocalFrontendHistory> localHistories;
+abstract class LeaderFrontendState implements Identifiable<ClientIdentifier> {
+ static final class Disabled extends LeaderFrontendState {
+ Disabled(final String persistenceId, final ClientIdentifier clientId, final ShardDataTree tree) {
+ super(persistenceId, clientId, tree);
+ }
- // RangeSet performs automatic merging, hence we keep minimal state tracking information
- private final UnsignedLongRangeSet purgedHistories;
+ @Override
+ LocalHistorySuccess handleLocalHistoryRequest(final LocalHistoryRequest<?> request,
+ final RequestEnvelope envelope, final long now) throws RequestException {
+ throw new UnsupportedRequestException(request);
+ }
- // Used for all standalone transactions
- private final AbstractFrontendHistory standaloneHistory;
- private final ShardDataTree tree;
- private final ClientIdentifier clientId;
- private final String persistenceId;
+ @Override
+ TransactionSuccess<?> handleTransactionRequest(final TransactionRequest<?> request,
+ final RequestEnvelope envelope, final long now) throws RequestException {
+ throw new UnsupportedRequestException(request);
+ }
+ }
- private long expectedTxSequence;
- private Long lastSeenHistory = null;
+ static final class Enabled extends LeaderFrontendState {
+ // Histories which have not been purged
+ private final Map<LocalHistoryIdentifier, LocalFrontendHistory> localHistories;
- // TODO: explicit failover notification
- // Record the ActorRef for the originating actor and when we switch to being a leader send a notification
- // to the frontend client -- that way it can immediately start sending requests
+ // RangeSet performs automatic merging, hence we keep minimal state tracking information
+ private final UnsignedLongRangeSet purgedHistories;
- // TODO: add statistics:
- // - number of requests processed
- // - number of histories processed
- // - per-RequestException throw counters
+ // Used for all standalone transactions
+ private final AbstractFrontendHistory standaloneHistory;
- LeaderFrontendState(final String persistenceId, final ClientIdentifier clientId, final ShardDataTree tree) {
- this(persistenceId, clientId, tree, UnsignedLongRangeSet.create(),
- StandaloneFrontendHistory.create(persistenceId, clientId, tree), new HashMap<>());
- }
+ private long expectedTxSequence;
+ private Long lastSeenHistory = null;
- LeaderFrontendState(final String persistenceId, final ClientIdentifier clientId, final ShardDataTree tree,
- final UnsignedLongRangeSet purgedHistories, final AbstractFrontendHistory standaloneHistory,
- final Map<LocalHistoryIdentifier, LocalFrontendHistory> localHistories) {
- this.persistenceId = Preconditions.checkNotNull(persistenceId);
- this.clientId = Preconditions.checkNotNull(clientId);
- this.tree = Preconditions.checkNotNull(tree);
- this.purgedHistories = Preconditions.checkNotNull(purgedHistories);
- this.standaloneHistory = Preconditions.checkNotNull(standaloneHistory);
- this.localHistories = Preconditions.checkNotNull(localHistories);
- }
+ Enabled(final String persistenceId, final ClientIdentifier clientId, final ShardDataTree tree) {
+ this(persistenceId, clientId, tree, UnsignedLongRangeSet.create(),
+ StandaloneFrontendHistory.create(persistenceId, clientId, tree), new HashMap<>());
+ }
- @Override
- public ClientIdentifier getIdentifier() {
- return clientId;
- }
+ Enabled(final String persistenceId, final ClientIdentifier clientId, final ShardDataTree tree,
+ final UnsignedLongRangeSet purgedHistories, final AbstractFrontendHistory standaloneHistory,
+ final Map<LocalHistoryIdentifier, LocalFrontendHistory> localHistories) {
+ super(persistenceId, clientId, tree);
+ this.purgedHistories = requireNonNull(purgedHistories);
+ this.standaloneHistory = requireNonNull(standaloneHistory);
+ this.localHistories = requireNonNull(localHistories);
+ }
- private void checkRequestSequence(final RequestEnvelope envelope) throws OutOfSequenceEnvelopeException {
- if (expectedTxSequence != envelope.getTxSequence()) {
- throw new OutOfSequenceEnvelopeException(expectedTxSequence);
+ @Override
+ @Nullable LocalHistorySuccess handleLocalHistoryRequest(final LocalHistoryRequest<?> request,
+ final RequestEnvelope envelope, final long now) throws RequestException {
+ checkRequestSequence(envelope);
+
+ try {
+ if (request instanceof CreateLocalHistoryRequest) {
+ return handleCreateHistory((CreateLocalHistoryRequest) request, envelope, now);
+ } else if (request instanceof DestroyLocalHistoryRequest) {
+ return handleDestroyHistory((DestroyLocalHistoryRequest) request, envelope, now);
+ } else if (request instanceof PurgeLocalHistoryRequest) {
+ return handlePurgeHistory((PurgeLocalHistoryRequest)request, envelope, now);
+ } else {
+ LOG.warn("{}: rejecting unsupported request {}", persistenceId(), request);
+ throw new UnsupportedRequestException(request);
+ }
+ } finally {
+ expectNextRequest();
+ }
}
- }
- private void expectNextRequest() {
- expectedTxSequence++;
- }
+ @Override
+ @Nullable TransactionSuccess<?> handleTransactionRequest(final TransactionRequest<?> request,
+ final RequestEnvelope envelope, final long now) throws RequestException {
+ checkRequestSequence(envelope);
+
+ try {
+ final LocalHistoryIdentifier lhId = request.getTarget().getHistoryId();
+ final AbstractFrontendHistory history;
+
+ if (lhId.getHistoryId() != 0) {
+ history = localHistories.get(lhId);
+ if (history == null) {
+ if (purgedHistories.contains(lhId.getHistoryId())) {
+ LOG.warn("{}: rejecting request {} to purged history", persistenceId(), request);
+ throw new DeadHistoryException(purgedHistories.toImmutable());
+ }
+
+ LOG.warn("{}: rejecting unknown history request {}", persistenceId(), request);
+ throw new UnknownHistoryException(lastSeenHistory);
+ }
+ } else {
+ history = standaloneHistory;
+ }
- @Nullable LocalHistorySuccess handleLocalHistoryRequest(final LocalHistoryRequest<?> request,
- final RequestEnvelope envelope, final long now) throws RequestException {
- checkRequestSequence(envelope);
-
- try {
- if (request instanceof CreateLocalHistoryRequest) {
- return handleCreateHistory((CreateLocalHistoryRequest) request, envelope, now);
- } else if (request instanceof DestroyLocalHistoryRequest) {
- return handleDestroyHistory((DestroyLocalHistoryRequest) request, envelope, now);
- } else if (request instanceof PurgeLocalHistoryRequest) {
- return handlePurgeHistory((PurgeLocalHistoryRequest)request, envelope, now);
- } else {
- LOG.warn("{}: rejecting unsupported request {}", persistenceId, request);
- throw new UnsupportedRequestException(request);
+ return history.handleTransactionRequest(request, envelope, now);
+ } finally {
+ expectNextRequest();
}
- } finally {
- expectNextRequest();
}
- }
- private LocalHistorySuccess handleCreateHistory(final CreateLocalHistoryRequest request,
- final RequestEnvelope envelope, final long now) throws RequestException {
- final LocalHistoryIdentifier historyId = request.getTarget();
- final AbstractFrontendHistory existing = localHistories.get(historyId);
- if (existing != null) {
- // History already exists: report success
- LOG.debug("{}: history {} already exists", persistenceId, historyId);
- return new LocalHistorySuccess(historyId, request.getSequence());
+ @Override
+ void reconnect() {
+ expectedTxSequence = 0;
+ super.reconnect();
}
- // We have not found the history. Before we create it we need to check history ID sequencing so that we do not
- // end up resurrecting a purged history.
- if (purgedHistories.contains(historyId.getHistoryId())) {
- LOG.debug("{}: rejecting purged request {}", persistenceId, request);
- throw new DeadHistoryException(purgedHistories.toImmutable());
+ @Override
+ void retire() {
+ super.retire();
+
+ // Clear out all transaction chains
+ localHistories.values().forEach(AbstractFrontendHistory::retire);
+ localHistories.clear();
+ standaloneHistory.retire();
}
- // Update last history we have seen
- if (lastSeenHistory == null || Long.compareUnsigned(lastSeenHistory, historyId.getHistoryId()) < 0) {
- lastSeenHistory = historyId.getHistoryId();
+ @Override
+ ToStringHelper addToStringAttributes(final ToStringHelper helper) {
+ return super.addToStringAttributes(helper).add("purgedHistories", purgedHistories);
}
- // We have to send the response only after persistence has completed
- final ShardDataTreeTransactionChain chain = tree.ensureTransactionChain(historyId, () -> {
- LOG.debug("{}: persisted history {}", persistenceId, historyId);
- envelope.sendSuccess(new LocalHistorySuccess(historyId, request.getSequence()), tree.readTime() - now);
- });
+ private LocalHistorySuccess handleCreateHistory(final CreateLocalHistoryRequest request,
+ final RequestEnvelope envelope, final long now) throws RequestException {
+ final LocalHistoryIdentifier historyId = request.getTarget();
+ final AbstractFrontendHistory existing = localHistories.get(historyId);
+ if (existing != null) {
+ // History already exists: report success
+ LOG.debug("{}: history {} already exists", persistenceId(), historyId);
+ return new LocalHistorySuccess(historyId, request.getSequence());
+ }
- localHistories.put(historyId, LocalFrontendHistory.create(persistenceId, tree, chain));
- LOG.debug("{}: created history {}", persistenceId, historyId);
- return null;
- }
+ // We have not found the history. Before we create it we need to check history ID sequencing so that we do
+ // not end up resurrecting a purged history.
+ if (purgedHistories.contains(historyId.getHistoryId())) {
+ LOG.debug("{}: rejecting purged request {}", persistenceId(), request);
+ throw new DeadHistoryException(purgedHistories.toImmutable());
+ }
- private LocalHistorySuccess handleDestroyHistory(final DestroyLocalHistoryRequest request,
- final RequestEnvelope envelope, final long now)
- throws RequestException {
- final LocalHistoryIdentifier id = request.getTarget();
- final LocalFrontendHistory existing = localHistories.get(id);
- if (existing == null) {
- // History does not exist: report success
- LOG.debug("{}: history {} does not exist, nothing to destroy", persistenceId, id);
- return new LocalHistorySuccess(id, request.getSequence());
- }
+ // Update last history we have seen
+ if (lastSeenHistory == null || Long.compareUnsigned(lastSeenHistory, historyId.getHistoryId()) < 0) {
+ lastSeenHistory = historyId.getHistoryId();
+ }
- existing.destroy(request.getSequence(), envelope, now);
- return null;
- }
+ // We have to send the response only after persistence has completed
+ final ShardDataTreeTransactionChain chain = tree().ensureTransactionChain(historyId, () -> {
+ LOG.debug("{}: persisted history {}", persistenceId(), historyId);
+ envelope.sendSuccess(new LocalHistorySuccess(historyId, request.getSequence()),
+ tree().readTime() - now);
+ });
- private LocalHistorySuccess handlePurgeHistory(final PurgeLocalHistoryRequest request,
- final RequestEnvelope envelope, final long now) throws RequestException {
- final LocalHistoryIdentifier id = request.getTarget();
- final LocalFrontendHistory existing = localHistories.remove(id);
- if (existing == null) {
- LOG.debug("{}: history {} has already been purged", persistenceId, id);
- return new LocalHistorySuccess(id, request.getSequence());
+ localHistories.put(historyId, LocalFrontendHistory.create(persistenceId(), tree(), chain));
+ LOG.debug("{}: created history {}", persistenceId(), historyId);
+ return null;
}
- LOG.debug("{}: purging history {}", persistenceId, id);
- purgedHistories.add(id.getHistoryId());
- existing.purge(request.getSequence(), envelope, now);
- return null;
- }
+ private LocalHistorySuccess handleDestroyHistory(final DestroyLocalHistoryRequest request,
+ final RequestEnvelope envelope, final long now) {
+ final LocalHistoryIdentifier id = request.getTarget();
+ final LocalFrontendHistory existing = localHistories.get(id);
+ if (existing == null) {
+ // History does not exist: report success
+ LOG.debug("{}: history {} does not exist, nothing to destroy", persistenceId(), id);
+ return new LocalHistorySuccess(id, request.getSequence());
+ }
- @Nullable TransactionSuccess<?> handleTransactionRequest(final TransactionRequest<?> request,
- final RequestEnvelope envelope, final long now) throws RequestException {
- checkRequestSequence(envelope);
+ existing.destroy(request.getSequence(), envelope, now);
+ return null;
+ }
- try {
- final LocalHistoryIdentifier lhId = request.getTarget().getHistoryId();
- final AbstractFrontendHistory history;
+ private LocalHistorySuccess handlePurgeHistory(final PurgeLocalHistoryRequest request,
+ final RequestEnvelope envelope, final long now) {
+ final LocalHistoryIdentifier id = request.getTarget();
+ final LocalFrontendHistory existing = localHistories.remove(id);
+ if (existing == null) {
+ LOG.debug("{}: history {} has already been purged", persistenceId(), id);
+ return new LocalHistorySuccess(id, request.getSequence());
+ }
- if (lhId.getHistoryId() != 0) {
- history = localHistories.get(lhId);
- if (history == null) {
- if (purgedHistories.contains(lhId.getHistoryId())) {
- LOG.warn("{}: rejecting request {} to purged history", persistenceId, request);
- throw new DeadHistoryException(purgedHistories.toImmutable());
- }
+ LOG.debug("{}: purging history {}", persistenceId(), id);
+ purgedHistories.add(id.getHistoryId());
+ existing.purge(request.getSequence(), envelope, now);
+ return null;
+ }
- LOG.warn("{}: rejecting unknown history request {}", persistenceId, request);
- throw new UnknownHistoryException(lastSeenHistory);
- }
- } else {
- history = standaloneHistory;
+ private void checkRequestSequence(final RequestEnvelope envelope) throws OutOfSequenceEnvelopeException {
+ if (expectedTxSequence != envelope.getTxSequence()) {
+ throw new OutOfSequenceEnvelopeException(expectedTxSequence);
}
+ }
- return history.handleTransactionRequest(request, envelope, now);
- } finally {
- expectNextRequest();
+ private void expectNextRequest() {
+ expectedTxSequence++;
}
}
+ private static final Logger LOG = LoggerFactory.getLogger(LeaderFrontendState.class);
+
+ private final ShardDataTree tree;
+ private final ClientIdentifier clientId;
+ private final String persistenceId;
+
+ private long lastConnectTicks;
+ private long lastSeenTicks;
+
+ // TODO: explicit failover notification
+ // Record the ActorRef for the originating actor and when we switch to being a leader send a notification
+ // to the frontend client -- that way it can immediately start sending requests
+
+ // TODO: add statistics:
+ // - number of requests processed
+ // - number of histories processed
+ // - per-RequestException throw counters
+
+ LeaderFrontendState(final String persistenceId, final ClientIdentifier clientId, final ShardDataTree tree) {
+ this.persistenceId = requireNonNull(persistenceId);
+ this.clientId = requireNonNull(clientId);
+ this.tree = requireNonNull(tree);
+ this.lastSeenTicks = tree.readTime();
+ }
+
+ @Override
+ public final ClientIdentifier getIdentifier() {
+ return clientId;
+ }
+
+ final String persistenceId() {
+ return persistenceId;
+ }
+
+ final long getLastConnectTicks() {
+ return lastConnectTicks;
+ }
+
+ final long getLastSeenTicks() {
+ return lastSeenTicks;
+ }
+
+ final ShardDataTree tree() {
+ return tree;
+ }
+
+ final void touch() {
+ this.lastSeenTicks = tree.readTime();
+ }
+
+ abstract @Nullable LocalHistorySuccess handleLocalHistoryRequest(LocalHistoryRequest<?> request,
+ RequestEnvelope envelope, long now) throws RequestException;
+
+ abstract @Nullable TransactionSuccess<?> handleTransactionRequest(TransactionRequest<?> request,
+ RequestEnvelope envelope, long now) throws RequestException;
+
void reconnect() {
- expectedTxSequence = 0;
+ lastConnectTicks = tree.readTime();
}
void retire() {
}
}
}
-
- // Clear out all transaction chains
- localHistories.values().forEach(AbstractFrontendHistory::retire);
- localHistories.clear();
- standaloneHistory.retire();
}
@Override
- public String toString() {
- return MoreObjects.toStringHelper(LeaderFrontendState.class).add("clientId", clientId)
- .add("purgedHistories", purgedHistories).toString();
+ public final String toString() {
+ return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
+ }
+
+ ToStringHelper addToStringAttributes(final ToStringHelper helper) {
+ return helper.add("clientId", clientId).add("nanosAgo", tree.readTime() - lastSeenTicks);
}
}