*/
package org.opendaylight.controller.cluster.datastore.entityownership;
-import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_NODE_ID;
import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NODE_ID;
import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_NODE_ID;
import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_QNAME;
import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithCandidate;
import akka.actor.ActorRef;
import akka.actor.ActorSelection;
+import akka.actor.Cancellable;
import akka.pattern.Patterns;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import org.opendaylight.controller.cluster.datastore.entityownership.messages.CandidateRemoved;
import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal;
+import org.opendaylight.controller.cluster.datastore.entityownership.messages.SelectOwner;
import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategy;
-import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.FirstCandidateSelectionStrategy;
+import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
import org.opendaylight.controller.cluster.datastore.messages.PeerDown;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
import scala.concurrent.Future;
+import scala.concurrent.duration.FiniteDuration;
/**
* Special Shard for EntityOwnership.
* @author Thomas Pantelis
*/
class EntityOwnershipShard extends Shard {
-
- private static final EntityOwnerSelectionStrategy DEFAULT_ENTITY_OWNER_SELECTION_STRATEGY
- = FirstCandidateSelectionStrategy.INSTANCE;
-
private final String localMemberName;
private final EntityOwnershipShardCommitCoordinator commitCoordinator;
private final EntityOwnershipListenerSupport listenerSupport;
private final Set<String> downPeerMemberNames = new HashSet<>();
private final Map<String, String> peerIdToMemberNames = new HashMap<>();
- private final Map<String, EntityOwnerSelectionStrategy> ownerSelectionStrategies = new HashMap<>();
+ private final EntityOwnerSelectionStrategyConfig strategyConfig;
+ private final Map<YangInstanceIdentifier, Cancellable> entityToScheduledOwnershipTask = new HashMap<>();
+ private final EntityOwnershipStatistics entityOwnershipStatistics;
private static DatastoreContext noPersistenceDatastoreContext(DatastoreContext datastoreContext) {
return DatastoreContext.newBuilderFrom(datastoreContext).persistent(false).build();
this.localMemberName = builder.localMemberName;
this.commitCoordinator = new EntityOwnershipShardCommitCoordinator(builder.localMemberName, LOG);
this.listenerSupport = new EntityOwnershipListenerSupport(getContext(), persistenceId());
+ this.strategyConfig = builder.ownerSelectionStrategyConfig;
+ this.entityOwnershipStatistics = new EntityOwnershipStatistics();
+ this.entityOwnershipStatistics.init(getDataStore());
for(String peerId: getRaftActorContext().getPeerIds()) {
ShardIdentifier shardId = ShardIdentifier.builder().fromShardIdString(peerId).build();
@Override
public void onReceiveCommand(final Object message) throws Exception {
if(message instanceof RegisterCandidateLocal) {
- onRegisterCandidateLocal((RegisterCandidateLocal)message);
+ onRegisterCandidateLocal((RegisterCandidateLocal) message);
} else if(message instanceof UnregisterCandidateLocal) {
onUnregisterCandidateLocal((UnregisterCandidateLocal)message);
} else if(message instanceof CandidateAdded){
onPeerDown((PeerDown) message);
} else if(message instanceof PeerUp) {
onPeerUp((PeerUp) message);
- } if(message instanceof RegisterListenerLocal) {
+ } else if(message instanceof RegisterListenerLocal) {
onRegisterListenerLocal((RegisterListenerLocal)message);
- } if(message instanceof UnregisterListenerLocal) {
- onUnregisterListenerLocal((UnregisterListenerLocal)message);
+ } else if(message instanceof UnregisterListenerLocal) {
+ onUnregisterListenerLocal((UnregisterListenerLocal) message);
+ } else if(message instanceof SelectOwner) {
+ onSelectOwner((SelectOwner) message);
} else if(!commitCoordinator.handleMessage(message, this)) {
super.onReceiveCommand(message);
}
}
+ private void onSelectOwner(SelectOwner selectOwner) {
+ String currentOwner = getCurrentOwner(selectOwner.getEntityPath());
+ if(Strings.isNullOrEmpty(currentOwner)) {
+ String entityType = EntityOwnersModel.entityTypeFromEntityPath(selectOwner.getEntityPath());
+ writeNewOwner(selectOwner.getEntityPath(), newOwner(selectOwner.getAllCandidates(),
+ entityOwnershipStatistics.byEntityType(entityType),
+ selectOwner.getOwnerSelectionStrategy()));
+
+ Cancellable cancellable = entityToScheduledOwnershipTask.get(selectOwner.getEntityPath());
+ if(cancellable != null){
+ if(!cancellable.isCancelled()){
+ cancellable.cancel();
+ }
+ entityToScheduledOwnershipTask.remove(selectOwner.getEntityPath());
+ }
+ }
+ }
+
private void onRegisterCandidateLocal(RegisterCandidateLocal registerCandidate) {
LOG.debug("{}: onRegisterCandidateLocal: {}", persistenceId(), registerCandidate);
protected void onStateChanged() {
super.onStateChanged();
- commitCoordinator.onStateChanged(this, isLeader());
+ boolean isLeader = isLeader();
+ if(LOG.isDebugEnabled()) {
+ LOG.debug("{}: onStateChanged: isLeader: {}, hasLeader: {}", persistenceId(), isLeader, hasLeader());
+ }
+
+ commitCoordinator.onStateChanged(this, isLeader);
}
@Override
protected void onLeaderChanged(String oldLeader, String newLeader) {
super.onLeaderChanged(oldLeader, newLeader);
+ boolean isLeader = isLeader();
LOG.debug("{}: onLeaderChanged: oldLeader: {}, newLeader: {}, isLeader: {}", persistenceId(), oldLeader,
- newLeader, isLeader());
+ newLeader, isLeader);
- if(isLeader()) {
+ if(isLeader) {
// We were just elected leader. If the old leader is down, select new owners for the entities
// owned by the down leader.
LOG.debug("{}: oldLeaderMemberName: {}", persistenceId(), oldLeaderMemberName);
if(downPeerMemberNames.contains(oldLeaderMemberName)) {
- selectNewOwnerForEntitiesOwnedBy(oldLeaderMemberName);
+ removeCandidateFromEntities(oldLeaderMemberName);
}
+ } else {
+ // The leader changed - notify the coordinator to check if pending modifications need to be sent.
+ // While onStateChanged also does this, this method handles the case where the shard hears from a
+ // leader and stays in the follower state. In that case no behavior state change occurs.
+ commitCoordinator.onStateChanged(this, isLeader);
}
}
if(isLeader()) {
String currentOwner = getCurrentOwner(message.getEntityPath());
- if(message.getRemovedCandidate().equals(currentOwner)){
- writeNewOwner(message.getEntityPath(), newOwner(message.getRemainingCandidates(),
- getEntityOwnerElectionStrategy(message.getEntityPath())));
+ if(message.getRemovedCandidate().equals(currentOwner) || message.getRemainingCandidates().size() == 0){
+ String entityType = EntityOwnersModel.entityTypeFromEntityPath(message.getEntityPath());
+ writeNewOwner(message.getEntityPath(),
+ newOwner(message.getRemainingCandidates(), entityOwnershipStatistics.byEntityType(entityType),
+ getEntityOwnerElectionStrategy(message.getEntityPath())));
}
} else {
// We're not the leader. If the removed candidate is our local member then check if we actually
}
private EntityOwnerSelectionStrategy getEntityOwnerElectionStrategy(YangInstanceIdentifier entityPath) {
- String entityType = EntityOwnersModel.entityTypeFromEntityPath(entityPath);
- EntityOwnerSelectionStrategy entityOwnerSelectionStrategy = ownerSelectionStrategies.get(entityType);
-
- if(entityOwnerSelectionStrategy == null){
- entityOwnerSelectionStrategy = DEFAULT_ENTITY_OWNER_SELECTION_STRATEGY;
- ownerSelectionStrategies.put(entityType, entityOwnerSelectionStrategy);
- }
-
- return entityOwnerSelectionStrategy;
+ final String entityType = EntityOwnersModel.entityTypeFromEntityPath(entityPath);
+ return strategyConfig.createStrategy(entityType);
}
private void onCandidateAdded(CandidateAdded message) {
downPeerMemberNames.remove(message.getNewCandidate());
String currentOwner = getCurrentOwner(message.getEntityPath());
+ EntityOwnerSelectionStrategy strategy = getEntityOwnerElectionStrategy(message.getEntityPath());
if(Strings.isNullOrEmpty(currentOwner)){
- EntityOwnerSelectionStrategy entityOwnerSelectionStrategy
- = getEntityOwnerElectionStrategy(message.getEntityPath());
- if(entityOwnerSelectionStrategy.selectionDelayInMillis() == 0L) {
+ if(strategy.getSelectionDelayInMillis() == 0L) {
+ String entityType = EntityOwnersModel.entityTypeFromEntityPath(message.getEntityPath());
writeNewOwner(message.getEntityPath(), newOwner(message.getAllCandidates(),
- entityOwnerSelectionStrategy));
+ entityOwnershipStatistics.byEntityType(entityType), strategy));
} else {
- throw new UnsupportedOperationException("Delayed selection not implemented yet");
+ scheduleOwnerSelection(message.getEntityPath(), message.getAllCandidates(), strategy);
}
}
}
peerIdToMemberNames.put(peerUp.getPeerId(), peerUp.getMemberName());
downPeerMemberNames.remove(peerUp.getMemberName());
- }
-
- private void selectNewOwnerForEntitiesOwnedBy(String owner) {
- final BatchedModifications modifications = commitCoordinator.newBatchedModifications();
- searchForEntitiesOwnedBy(owner, new EntityWalker() {
- @Override
- public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) {
- YangInstanceIdentifier entityPath = YangInstanceIdentifier.builder(ENTITY_TYPES_PATH).
- node(entityTypeNode.getIdentifier()).node(ENTITY_NODE_ID).node(entityNode.getIdentifier()).
- node(ENTITY_OWNER_NODE_ID).build();
-
- Object newOwner = newOwner(getCandidateNames(entityNode), getEntityOwnerElectionStrategy(entityPath));
-
- LOG.debug("{}: Found entity {}, writing new owner {}", persistenceId(), entityPath, newOwner);
-
- modifications.addModification(new WriteModification(entityPath,
- ImmutableNodes.leafNode(ENTITY_OWNER_NODE_ID, newOwner)));
- }
- });
-
- commitCoordinator.commitModifications(modifications, this);
+ // Notify the coordinator to check if pending modifications need to be sent. We do this here
+ // to handle the case where the leader's peer address isn't now yet when a prior state or
+ // leader change occurred.
+ commitCoordinator.onStateChanged(this, isLeader());
}
private void removeCandidateFromEntities(final String owner) {
searchForEntities(new EntityWalker() {
@Override
public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) {
- if(hasCandidate(entityNode, owner)) {
+ if (hasCandidate(entityNode, owner)) {
YangInstanceIdentifier entityId =
- (YangInstanceIdentifier)entityNode.getIdentifier().getKeyValues().get(ENTITY_ID_QNAME);
+ (YangInstanceIdentifier) entityNode.getIdentifier().getKeyValues().get(ENTITY_ID_QNAME);
YangInstanceIdentifier candidatePath = candidatePath(
entityTypeNode.getIdentifier().getKeyValues().get(ENTITY_TYPE_QNAME).toString(),
entityId, owner);
public void onEntity(MapEntryNode entityTypeNode, MapEntryNode entityNode) {
Optional<DataContainerChild<? extends PathArgument, ?>> possibleOwner =
entityNode.getChild(ENTITY_OWNER_NODE_ID);
- if(possibleOwner.isPresent() && owner.equals(possibleOwner.get().getValue().toString())) {
+ if (possibleOwner.isPresent() && owner.equals(possibleOwner.get().getValue().toString())) {
walker.onEntity(entityTypeNode, entityNode);
}
}
}
}
- private static Collection<String> getCandidateNames(MapEntryNode entity) {
- Collection<MapEntryNode> candidates = ((MapNode)entity.getChild(CANDIDATE_NODE_ID).get()).getValue();
- Collection<String> candidateNames = new ArrayList<>(candidates.size());
- for(MapEntryNode candidate: candidates) {
- candidateNames.add(candidate.getChild(CANDIDATE_NAME_NODE_ID).get().getValue().toString());
- }
-
- return candidateNames;
- }
-
private void writeNewOwner(YangInstanceIdentifier entityPath, String newOwner) {
LOG.debug("{}: Writing new owner {} for entity {}", persistenceId(), newOwner, entityPath);
ImmutableNodes.leafNode(ENTITY_OWNER_NODE_ID, newOwner)), this);
}
- private String newOwner(Collection<String> candidates, EntityOwnerSelectionStrategy ownerSelectionStrategy) {
+ /**
+ * Schedule a new owner selection job. Cancelling any outstanding job if it has not been cancelled.
+ *
+ * @param entityPath
+ * @param allCandidates
+ */
+ public void scheduleOwnerSelection(YangInstanceIdentifier entityPath, Collection<String> allCandidates,
+ EntityOwnerSelectionStrategy strategy){
+ Cancellable lastScheduledTask = entityToScheduledOwnershipTask.get(entityPath);
+ if(lastScheduledTask != null && !lastScheduledTask.isCancelled()){
+ lastScheduledTask.cancel();
+ }
+ lastScheduledTask = context().system().scheduler().scheduleOnce(
+ FiniteDuration.apply(strategy.getSelectionDelayInMillis(), TimeUnit.MILLISECONDS)
+ , self(), new SelectOwner(entityPath, allCandidates, strategy)
+ , context().system().dispatcher(), self());
+
+ entityToScheduledOwnershipTask.put(entityPath, lastScheduledTask);
+ }
+
+ private String newOwner(Collection<String> candidates, Map<String, Long> statistics, EntityOwnerSelectionStrategy ownerSelectionStrategy) {
Collection<String> viableCandidates = getViableCandidates(candidates);
if(viableCandidates.size() == 0){
return "";
}
- return ownerSelectionStrategy.newOwner(viableCandidates);
+ return ownerSelectionStrategy.newOwner(viableCandidates, statistics);
}
private Collection<String> getViableCandidates(Collection<String> candidates) {
static class Builder extends Shard.AbstractBuilder<Builder, EntityOwnershipShard> {
private String localMemberName;
+ private EntityOwnerSelectionStrategyConfig ownerSelectionStrategyConfig;
protected Builder() {
super(EntityOwnershipShard.class);
return this;
}
+ Builder ownerSelectionStrategyConfig(EntityOwnerSelectionStrategyConfig ownerSelectionStrategyConfig){
+ checkSealed();
+ this.ownerSelectionStrategyConfig = ownerSelectionStrategyConfig;
+ return this;
+ }
+
@Override
protected void verify() {
super.verify();
Preconditions.checkNotNull(localMemberName, "localMemberName should not be null");
+ Preconditions.checkNotNull(ownerSelectionStrategyConfig, "ownerSelectionStrategyConfig should not be null");
}
}
}
Code Review / controller.git / blobdiff